Switch to src layout.

materialsproject · Jun 26, 2024 · 3bc9e38 · 3bc9e38
1 parent 8345dfd
commit 3bc9e38
Show file tree

Hide file tree

Showing 44 changed files with 3 additions and 3 deletions.
diff --git a/pyproject.toml b/pyproject.toml
@@ -57,8 +57,8 @@ Repo = "https://github.com/materialsproject/custodian"
 Package = "https://pypi.org/project/custodian"
 
 [tool.setuptools.packages.find]
-include = ["custodian*"]
-exclude = ["*.tests", "*.tests.*"]
+where = ["src"]
+include = ["custodian"]
 
 [tool.ruff]
 target-version = "py311"

diff --git a/custodian/__init__.py → src/custodian/__init__.py b/custodian/__init__.py → src/custodian/__init__.py
diff --git a/custodian/ansible/__init__.py → src/custodian/ansible/__init__.py b/custodian/ansible/__init__.py → src/custodian/ansible/__init__.py
diff --git a/custodian/ansible/actions.py → src/custodian/ansible/actions.py b/custodian/ansible/actions.py → src/custodian/ansible/actions.py
diff --git a/custodian/ansible/interpreter.py → src/custodian/ansible/interpreter.py b/custodian/ansible/interpreter.py → src/custodian/ansible/interpreter.py
diff --git a/custodian/cli/__init__.py → src/custodian/cli/__init__.py b/custodian/cli/__init__.py → src/custodian/cli/__init__.py
diff --git a/custodian/cli/converge_geometry.py → src/custodian/cli/converge_geometry.py b/custodian/cli/converge_geometry.py → src/custodian/cli/converge_geometry.py
diff --git a/custodian/cli/converge_kpoints.py → src/custodian/cli/converge_kpoints.py b/custodian/cli/converge_kpoints.py → src/custodian/cli/converge_kpoints.py
diff --git a/custodian/cli/cstdn.py → src/custodian/cli/cstdn.py b/custodian/cli/cstdn.py → src/custodian/cli/cstdn.py
diff --git a/custodian/cli/run_nwchem.py → src/custodian/cli/run_nwchem.py b/custodian/cli/run_nwchem.py → src/custodian/cli/run_nwchem.py
diff --git a/custodian/cli/run_vasp.py → src/custodian/cli/run_vasp.py b/custodian/cli/run_vasp.py → src/custodian/cli/run_vasp.py
diff --git a/custodian/cp2k/__init__.py → src/custodian/cp2k/__init__.py b/custodian/cp2k/__init__.py → src/custodian/cp2k/__init__.py
diff --git a/custodian/cp2k/handlers.py → src/custodian/cp2k/handlers.py b/custodian/cp2k/handlers.py → src/custodian/cp2k/handlers.py
diff --git a/custodian/cp2k/interpreter.py → src/custodian/cp2k/interpreter.py b/custodian/cp2k/interpreter.py → src/custodian/cp2k/interpreter.py
diff --git a/custodian/cp2k/jobs.py → src/custodian/cp2k/jobs.py b/custodian/cp2k/jobs.py → src/custodian/cp2k/jobs.py
diff --git a/custodian/cp2k/utils.py → src/custodian/cp2k/utils.py b/custodian/cp2k/utils.py → src/custodian/cp2k/utils.py
diff --git a/custodian/cp2k/validators.py → src/custodian/cp2k/validators.py b/custodian/cp2k/validators.py → src/custodian/cp2k/validators.py
diff --git a/custodian/custodian.py → src/custodian/custodian.py b/custodian/custodian.py → src/custodian/custodian.py
diff --git a/custodian/feff/__init__.py → src/custodian/feff/__init__.py b/custodian/feff/__init__.py → src/custodian/feff/__init__.py
diff --git a/custodian/feff/handlers.py → src/custodian/feff/handlers.py b/custodian/feff/handlers.py → src/custodian/feff/handlers.py
diff --git a/custodian/feff/interpreter.py → src/custodian/feff/interpreter.py b/custodian/feff/interpreter.py → src/custodian/feff/interpreter.py
diff --git a/custodian/feff/jobs.py → src/custodian/feff/jobs.py b/custodian/feff/jobs.py → src/custodian/feff/jobs.py
diff --git a/custodian/gaussian/__init__.py → src/custodian/gaussian/__init__.py b/custodian/gaussian/__init__.py → src/custodian/gaussian/__init__.py
diff --git a/custodian/gaussian/handlers.py → src/custodian/gaussian/handlers.py b/custodian/gaussian/handlers.py → src/custodian/gaussian/handlers.py
diff --git a/custodian/gaussian/jobs.py → src/custodian/gaussian/jobs.py b/custodian/gaussian/jobs.py → src/custodian/gaussian/jobs.py
diff --git a/custodian/lobster/__init__.py → src/custodian/lobster/__init__.py b/custodian/lobster/__init__.py → src/custodian/lobster/__init__.py
diff --git a/custodian/lobster/handlers.py → src/custodian/lobster/handlers.py b/custodian/lobster/handlers.py → src/custodian/lobster/handlers.py
diff --git a/custodian/lobster/jobs.py → src/custodian/lobster/jobs.py b/custodian/lobster/jobs.py → src/custodian/lobster/jobs.py
diff --git a/custodian/nwchem/__init__.py → src/custodian/nwchem/__init__.py b/custodian/nwchem/__init__.py → src/custodian/nwchem/__init__.py
diff --git a/custodian/nwchem/handlers.py → src/custodian/nwchem/handlers.py b/custodian/nwchem/handlers.py → src/custodian/nwchem/handlers.py
diff --git a/custodian/nwchem/jobs.py → src/custodian/nwchem/jobs.py b/custodian/nwchem/jobs.py → src/custodian/nwchem/jobs.py
diff --git a/custodian/qchem/__init__.py → src/custodian/qchem/__init__.py b/custodian/qchem/__init__.py → src/custodian/qchem/__init__.py
diff --git a/custodian/qchem/handlers.py → src/custodian/qchem/handlers.py b/custodian/qchem/handlers.py → src/custodian/qchem/handlers.py
diff --git a/custodian/qchem/jobs.py → src/custodian/qchem/jobs.py b/custodian/qchem/jobs.py → src/custodian/qchem/jobs.py
diff --git a/custodian/qchem/utils.py → src/custodian/qchem/utils.py b/custodian/qchem/utils.py → src/custodian/qchem/utils.py
diff --git a/custodian/utils.py → src/custodian/utils.py b/custodian/utils.py → src/custodian/utils.py
diff --git a/custodian/vasp/__init__.py → src/custodian/vasp/__init__.py b/custodian/vasp/__init__.py → src/custodian/vasp/__init__.py
diff --git a/custodian/vasp/handlers.py → src/custodian/vasp/handlers.py b/custodian/vasp/handlers.py → src/custodian/vasp/handlers.py
diff --git a/custodian/vasp/interpreter.py → src/custodian/vasp/interpreter.py b/custodian/vasp/interpreter.py → src/custodian/vasp/interpreter.py
diff --git a/custodian/vasp/io.py → src/custodian/vasp/io.py b/custodian/vasp/io.py → src/custodian/vasp/io.py
diff --git a/custodian/vasp/jobs.py → src/custodian/vasp/jobs.py b/custodian/vasp/jobs.py → src/custodian/vasp/jobs.py
diff --git a/custodian/vasp/utils.py → src/custodian/vasp/utils.py b/custodian/vasp/utils.py → src/custodian/vasp/utils.py
diff --git a/custodian/vasp/validators.py → src/custodian/vasp/validators.py b/custodian/vasp/validators.py → src/custodian/vasp/validators.py
diff --git a/tasks.py b/tasks.py
@@ -21,7 +21,7 @@ def make_doc(ctx) -> None:
     with cd("docs"):
         ctx.run("touch index.rst")
         ctx.run("rm custodian.*.rst", warn=True)
-        ctx.run("sphinx-apidoc --separate -P -M -d 7 -o . -f ../custodian  ../**/tests/*")
+        ctx.run("sphinx-apidoc --separate -P -M -d 7 -o . -f ../src/custodian")
         ctx.run("sphinx-build -M markdown . .")
         ctx.run("rm *.rst", warn=True)
         ctx.run("cp markdown/custodian*.md .")