Move code to a src directory

This is gaining traction in the community as well as avoiding some potential testing pitfalls, see https://hynek.me/articles/testing-packaging/
python-hyper · Feb 15, 2020 · 07723dc · 07723dc
1 parent d795938
commit 07723dc
Show file tree

Hide file tree

Showing 12 changed files with 7 additions and 7 deletions.
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -2,7 +2,7 @@ graft compliance
 graft example
 graft docs
 graft test
-graft wsproto
+graft src/wsproto
 prune docs/build
 prune compliance/autobahntestsuite-venv
 prune compliance/reports

diff --git a/setup.py b/setup.py
@@ -13,7 +13,7 @@
 
 # Get the version
 version_regex = r'__version__ = ["\']([^"\']*)["\']'
-with open(os.path.join(PROJECT_ROOT, 'wsproto/__init__.py')) as file_:
+with open(os.path.join(PROJECT_ROOT, 'src/wsproto/__init__.py')) as file_:
     text = file_.read()
     match = re.search(version_regex, text)
 
@@ -35,9 +35,9 @@
     author='Benno Rice',
     author_email='benno@jeamland.net',
     url='https://github.com/python-hyper/wsproto/',
-    packages=find_packages(exclude=['test']),
+    packages=find_packages("src"),
+    package_dir={"": "src"},
     package_data={'': ['LICENSE', 'README.rst']},
-    package_dir={'wsproto': 'wsproto'},
     python_requires=">=3.6.1",
     include_package_data=True,
     license='MIT',

diff --git a/wsproto/__init__.py → src/wsproto/__init__.py b/wsproto/__init__.py → src/wsproto/__init__.py
diff --git a/wsproto/connection.py → src/wsproto/connection.py b/wsproto/connection.py → src/wsproto/connection.py
diff --git a/wsproto/events.py → src/wsproto/events.py b/wsproto/events.py → src/wsproto/events.py
diff --git a/wsproto/extensions.py → src/wsproto/extensions.py b/wsproto/extensions.py → src/wsproto/extensions.py
diff --git a/wsproto/frame_protocol.py → src/wsproto/frame_protocol.py b/wsproto/frame_protocol.py → src/wsproto/frame_protocol.py
diff --git a/wsproto/handshake.py → src/wsproto/handshake.py b/wsproto/handshake.py → src/wsproto/handshake.py
diff --git a/wsproto/py.typed → src/wsproto/py.typed b/wsproto/py.typed → src/wsproto/py.typed
diff --git a/wsproto/typing.py → src/wsproto/typing.py b/wsproto/typing.py → src/wsproto/typing.py
diff --git a/wsproto/utilities.py → src/wsproto/utilities.py b/wsproto/utilities.py → src/wsproto/utilities.py
diff --git a/tox.ini b/tox.ini
@@ -29,14 +29,14 @@ deps =
     black
     isort
 commands =
-    black --check --diff wsproto/ test/ example/ compliance/
-    isort --dont-skip __init__.py --diff --check --settings-path setup.cfg --recursive wsproto test example compliance
+    black --check --diff src/wsproto/ test/ example/ compliance/
+    isort --dont-skip __init__.py --diff --check --settings-path setup.cfg --recursive src/wsproto test example compliance
 
 [testenv:mypy]
 basepython = python3.8
 deps = mypy
 commands =
-    mypy wsproto/ test/ example/
+    mypy src/wsproto/ test/ example/
 
 [testenv:lint]
 basepython = python3.8