Move to src layout

.github/workflows/test-matrix.yml

@@ -1,7 +1,7 @@
 # Generated from:
 # https://github.com/plone/meta/tree/main/src/plone/meta/default
 # See the inline comments on how to expand/tweak this configuration file
-name: tests
+name: Tests
 
 on:
   push:
@@ -50,5 +50,10 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install tox
+    - name: Initialize tox
+      # the bash one-liner below does not work on Windows
+      if: contains(matrix.os, 'ubuntu')
+      run: |
+        if [ `tox list --no-desc -f init|wc -l` = 1 ]; then tox -e init;else true; fi
     - name: Test
       run: tox -e ${{ matrix.config[2] }}

CHANGES.rst

@@ -16,6 +16,7 @@ Changelog
 - Fixed the warning "Line to long" message
   [macagua]
 
+- Move distribution to src layout [gforcada]
 
 3.0.7 (2024-08-28)
 ------------------

MANIFEST.in

@@ -1,5 +1,5 @@
 recursive-include resources *.js
-recursive-include plone *
+recursive-include src *
 recursive-include docs *
 include *
 global-exclude *.pyc

pyproject.toml

@@ -2,7 +2,7 @@
 # https://github.com/plone/meta/tree/main/src/plone/meta/default
 # See the inline comments on how to expand/tweak this configuration file
 [build-system]
-requires = ["setuptools>=68.2"]
+requires = ["setuptools>=68.2,<80", "wheel"]
 
 ##
 # Add extra configuration options in .meta.toml:

setup.py

@@ -1,24 +1,17 @@
+from pathlib import Path
 from setuptools import find_packages
 from setuptools import setup
 
-import os
-
 
 version = "3.0.8.dev0"
 
 
-def read(*rnames):
-    with open(os.path.join(os.path.dirname(__file__), *rnames)) as f:
-        return f.read()
-
-
 setup(
     name="plone.formwidget.geolocation",
     version=version,
     description="Geolocation field and widget",
-    long_description="{}\n{}".format(
-        read("README.rst"),
-        read("CHANGES.rst"),
+    long_description=(
+        f"{Path('README.rst').read_text()}\n{Path('CHANGES.rst').read_text()}\n"
     ),
     classifiers=[
         "Framework :: Plone",
@@ -36,7 +29,8 @@ def read(*rnames):
     author_email="[email protected]",
     url="https://github.com/collective/plone.formwidget.geolocation",
     license="GPL",
-    packages=find_packages(),
+    packages=find_packages("src"),
+    package_dir={"": "src"},
     namespace_packages=["plone", "plone.formwidget"],
     include_package_data=True,
     zip_safe=False,

tox.ini

@@ -90,9 +90,9 @@ commands =
 [test_runner]
 deps = zope.testrunner
 test =
-    zope-testrunner --all --test-path={toxinidir} -s plone.formwidget.geolocation {posargs}
+    zope-testrunner --all --test-path={toxinidir}/src -s plone.formwidget.geolocation {posargs}
 coverage =
-    coverage run --branch --source plone.formwidget.geolocation {envbindir}/zope-testrunner --quiet --all --test-path={toxinidir} -s plone.formwidget.geolocation {posargs}
+    coverage run --branch --source plone.formwidget.geolocation {envbindir}/zope-testrunner --quiet --all --test-path={toxinidir}/src -s plone.formwidget.geolocation {posargs}
     coverage report -m --format markdown
     coverage xml
     coverage html
@@ -161,6 +161,7 @@ set_env = {[base]set_env}
 deps =
     {[test_runner]deps}
     -c https://dist.plone.org/release/6.2-dev/constraints.txt
+
 commands = {[test_runner]test}
 extras = {[base]extras}
 
@@ -186,6 +187,7 @@ deps =
     {[test_runner]deps}
     coverage
     -c https://dist.plone.org/release/6.2-dev/constraints.txt
+
 commands = {[test_runner]coverage}
 extras = {[base]extras}