Convert project to use a src layout (#22)

Author: bdraco

.mypy.ini

@@ -5,7 +5,7 @@ error_summary = true
 files =
   packaging/,
   tests/,
-  propcache/
+  src/propcache/
 
 # check_untyped_defs = true
 

CHANGES/22.packaging.rst

@@ -0,0 +1 @@
+Converted project to use a src layout -- by :user:`bdraco`.

Makefile

@@ -1,4 +1,4 @@
-PYXS = $(wildcard propcache/*.pyx)
+PYXS = $(wildcard src/propcache/*.pyx)
 SRC = propcache tests
 
 all: test
@@ -15,8 +15,8 @@ all: test
 	touch .install-cython
 
 
-propcache/%.c: propcache/%.pyx
-	python -m cython -3 -o $@ $< -I propcache
+src/propcache/%.c: src/propcache/%.pyx
+	python -m cython -3 -o $@ $< -I src/propcache
 
 
 .cythonize: .install-cython $(PYXS:.pyx=.c)
@@ -25,7 +25,7 @@ propcache/%.c: propcache/%.pyx
 cythonize: .cythonize
 
 
-.develop: .install-deps $(shell find propcache -type f)
+.develop: .install-deps $(shell find src/propcache -type f)
 	@pip install -e .
 	@touch .develop
 
@@ -39,15 +39,15 @@ endif
 lint: fmt
 
 test: lint .develop
-	pytest ./tests ./propcache
+	pytest ./tests
 
 
 vtest: lint .develop
-	pytest ./tests ./propcache -v
+	pytest -v ./tests
 
 
 cov: lint .develop
-	pytest --cov propcache --cov-report html --cov-report term ./tests/ ./propcache/
+	pytest --cov src/propcache --cov-report html --cov-report term ./tests
 	@echo "open file://`pwd`/htmlcov/index.html"
 
 

docs/conf.py

@@ -40,8 +40,7 @@
 
 
 _docs_path = Path(__file__).parent
-_version_path = _docs_path / "../propcache/__init__.py"
-
+_version_path = _docs_path / "../src/propcache/__init__.py"
 
 with _version_path.open() as fp:
     try:

docs/spelling_wordlist.txt

@@ -42,6 +42,7 @@ requote
 requoting
 runtimes
 sdist
+src
 subclass
 subclasses
 subcomponent

pyproject.toml

@@ -12,7 +12,7 @@ build-backend = "pep517_backend.hooks"  # wraps `setuptools.build_meta`
 
 [tool.local.cythonize]
 # This attr can contain multiple globs
-src = ["propcache/*.pyx"]
+src = ["src/propcache/*.pyx"]
 
 [tool.local.cythonize.env]
 # Env vars provisioned during cythonize call

pytest.ini

@@ -85,4 +85,6 @@ norecursedirs =
 
 testpaths = tests/
 
+pythonpath = src
+
 xfail_strict = true

setup.cfg

@@ -57,10 +57,11 @@ python_requires = >=3.8
 # Ref:
 # https://setuptools.pypa.io/en/latest/userguide/declarative_config.html#using-a-src-layout
 # (`src/` layout)
-# package_dir =
-#   = src
+package_dir =
+    =src
 packages =
   propcache
+
 # https://setuptools.pypa.io/en/latest/deprecated/zip_safe.html
 zip_safe = False
 include_package_data = True
@@ -71,6 +72,7 @@ include_package_data = True
 # (see notes for the asterisk/`*` meaning)
 * =
   *.so
+  *.pyx
 
 [options.exclude_package_data]
 * =