MNT: move siphon source to src/ directory

joelrahman · Nov 17, 2021 · 5fec8ab · 5fec8ab
1 parent feb7f60
commit 5fec8ab
Show file tree

Hide file tree

Showing 187 changed files with 721 additions and 298 deletions.
diff --git a/.checkignore b/.checkignore
@@ -3,11 +3,11 @@
 #
 
 # Ignore versioneer stuff
-siphon/_version.py
+src/siphon/_version.py
 versioneer.py
 
 # Ignore generated protobuf files
-siphon/cdmr/*_pb2.py
+src/siphon/cdmr/*_pb2.py
 
 # Don't scan sphinx config
 docs/source/conf.py
diff --git a/.coveragerc b/.coveragerc
@@ -1,2 +1,2 @@
 [run]
-omit = siphon/_version.py,siphon/cdmr/*_pb2.py
+omit = src/siphon/_version.py,src/siphon/cdmr/*_pb2.py
diff --git a/.gitattributes b/.gitattributes
@@ -1,3 +1,3 @@
-siphon/_version.py export-subst
+src/siphon/_version.py export-subst
 
 *.ipynb	diff=jupyternotebook
diff --git a/.github/workflows/tests-conda.yml b/.github/workflows/tests-conda.yml
@@ -69,7 +69,7 @@ jobs:
       # By running coverage in "parallel" mode and "combining", we can clean up the path names
       run: |
         export TEST_DATA_DIR=$GITHUB_WORKSPACE/staticdata
-        python -m coverage run -p -m pytest siphon
+        python -m coverage run -p -m pytest src/siphon
         python -m coverage combine
         python -m coverage report
         python -m coverage xml

diff --git a/.github/workflows/tests-pypi.yml b/.github/workflows/tests-pypi.yml
@@ -77,7 +77,7 @@ jobs:
 
     - name: Run tests
       run: |
-        python -m coverage run -p -m pytest siphon/
+        python -m coverage run -p -m pytest src/siphon
         python -m coverage combine
         python -m coverage report
         python -m coverage xml

diff --git a/.prospector.yaml b/.prospector.yaml
@@ -2,9 +2,9 @@ ignore-paths:
   - doc
   - build
   - versioneer.py
-  - siphon/_version.py
-  - siphon/cdmr/ncStream_pb2.py
-  - siphon/cdmr/cdmrfeature_pb2.py
+  - src/siphon/_version.py
+  - src/siphon/cdmr/ncStream_pb2.py
+  - src/siphon/cdmr/cdmrfeature_pb2.py
   - examples
 
 pylint:

diff --git a/.stickler.yml b/.stickler.yml
@@ -3,4 +3,4 @@ linters:
         ignore: 'F405'
         max-line-length: 95
 files:
-    ignore: ['siphon/cdmr/ncStream_pb2.py', 'siphon/cdmr/cdmrfeature_pb2.py', 'siphon/_version.py']
+    ignore: ['src/siphon/cdmr/ncStream_pb2.py', 'src/siphon/cdmr/cdmrfeature_pb2.py', 'src/siphon/_version.py']
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -2,10 +2,10 @@ include README.rst
 include LICENSE
 include CONTRIBUTING.md
 include versioneer.py
-include siphon/_version.py
+include src/siphon/_version.py
 recursive-include examples *
 recursive-include docs *
-recursive-include siphon/tests *
+recursive-include src/siphon/tests *
 prune docs/build
 prune docs/examples
 prune docs/api/generated

diff --git a/setup.cfg b/setup.cfg
@@ -12,9 +12,9 @@ docstring-convention = numpy
 exclude =
     docs
     build
-    siphon/cdmr/ncStream_pb2.py
-    siphon/cdmr/cdmrfeature_pb2.py
-    siphon/_version.py
+    src/siphon/cdmr/ncStream_pb2.py
+    src/siphon/cdmr/cdmrfeature_pb2.py
+    src/siphon/_version.py
     versioneer.py
 select = A B C D E F H I M Q RST S T W B902
 ignore = F405 W503 RST902 SIM
@@ -31,14 +31,22 @@ max-line-length = 95
 [metadata]
 description-file = README.rst
 
+[options]
+package_dir =
+    = src
+packages = find:
+
+[options.packages.find]
+where = src
+
 [bdist_wheel]
 # This flag says that the code is written to work on both Python 2 and 3.
 universal=1
 
 [versioneer]
 VCS = git
 style = pep440
-versionfile_source = siphon/_version.py
+versionfile_source = src/siphon/_version.py
 versionfile_build = siphon/_version.py
 tag_prefix = v
 parentdir_prefix = siphon-

diff --git a/siphon/__init__.py → src/siphon/__init__.py b/siphon/__init__.py → src/siphon/__init__.py
@@ -4,6 +4,5 @@
 """Tools for accessing atmospheric and oceanic science data on remote servers."""
 
 # Version import needs to come first so everyone else can pull on import
-from ._version import get_versions
-__version__ = get_versions()['version']
-del get_versions
+from . import _version
+__version__ = _version.get_versions()['version']
diff --git a/siphon/_tools.py → src/siphon/_tools.py b/siphon/_tools.py → src/siphon/_tools.py