switch to src layout

FAIRmat-NFDI · Oct 11, 2024 · 9184e73 · 9184e73
1 parent f99e84b
commit 9184e73
Show file tree

Hide file tree

Showing 7 changed files with 10 additions and 8 deletions.
diff --git a/.github/workflows/pylint.yml b/.github/workflows/pylint.yml
@@ -21,10 +21,10 @@ jobs:
           uv pip install -r dev-requirements.txt
       - name: ruff check
         run: |
-          ruff check pynxtools_mpes tests
+          ruff check src/pynxtools_mpes tests
       - name: ruff format
         run: |
-          ruff format --check pynxtools_mpes tests
+          ruff format --check src/pynxtools_mpes tests
       - name: mypy
         run: |
-          mypy pynxtools_mpes tests
+          mypy src/pynxtools_mpes tests
diff --git a/docs/reference/mpes.md b/docs/reference/mpes.md
@@ -2,7 +2,7 @@
 
 The reader supports [HDF5](https://www.hdfgroup.org/solutions/hdf5/) files created using the MPES instruments at the Department of Physical Chemistry of the [Fritz Haber Institute of the Max Planck Society (FHI)](https://pc.fhi-berlin.mpg.de).
 
-The reader for can be found [here](https://github.com/FAIRmat-NFDI/pynxtools-mpes/blob/main/pynxtools_mpes/reader.py).
+The reader for can be found [here](https://github.com/FAIRmat-NFDI/pynxtools-mpes/blob/main/src/pynxtools_mpes/reader.py).
 
 Example data for the MPES reader is available [here](https://github.com/FAIRmat-NFDI/pynxtools-mpes/tree/main/tests/data).
 

diff --git a/mkdocs.yaml b/mkdocs.yaml
@@ -20,7 +20,7 @@ nav:
 plugins:
   - search
   - macros:
-      module_name: pynxtools_mpes/mkdocs
+      module_name: src/pynxtools_mpes/mkdocs
 
 theme:
   name: material

diff --git a/pyproject.toml b/pyproject.toml
@@ -55,13 +55,15 @@ docs = [
 [project.entry-points."pynxtools.reader"]
 mpes = "pynxtools_mpes.reader:MPESReader"
 
-[tool.setuptools]
-packages = ["pynxtools_mpes"]
+[tool.setuptools.packages.find]
+where = [
+    "src",
+]
 
 [tool.setuptools_scm]
 
 [tool.ruff]
-include = ["pynxtools_mpes/*.py", "tests/*.py"]
+include = ["src/*.py", "tests/*.py"]
 line-length = 88
 indent-width = 4
 

diff --git a/pynxtools_mpes/__init__.py → src/pynxtools_mpes/__init__.py b/pynxtools_mpes/__init__.py → src/pynxtools_mpes/__init__.py
diff --git a/pynxtools_mpes/mkdocs.py → src/pynxtools_mpes/mkdocs.py b/pynxtools_mpes/mkdocs.py → src/pynxtools_mpes/mkdocs.py
diff --git a/pynxtools_mpes/reader.py → src/pynxtools_mpes/reader.py b/pynxtools_mpes/reader.py → src/pynxtools_mpes/reader.py