Merge pull request #160 from kyleaoman/pyproject_toml

Move from setup.py to pyproject.toml

.github/workflows/pytest.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.8, 3.9]
+        python-version: [3.8, 3.9, "3.10", "3.11"]
 
     steps:
     - uses: actions/checkout@v2

.gitignore

@@ -1,3 +1,8 @@
+# Temporary files
+*~
+\#*
+.\#*
+
 # Python environment.
 env/*
 

docs/source/getting_started/index.rst

@@ -38,8 +38,6 @@ Optional packages
   that do not store this variable in the snapshots (e.g. dark matter)
 + ``tqdm``, required for progress bars for some long-running tasks. If not installed
   no progress bar will be shown.
-+ ``py-sphviewer``, if you wish to use our integration with this visualisation
-  code.
 
 
 Installing

docs/source/visualisation/index.rst

@@ -24,14 +24,11 @@ The output of these functions comes with associated units and has the correct
 dimensions. There are lower-level APIs (also documented here) that provide
 additional functionality.
 
-Finally, we also describe here the integration with :mod:`py-sphviewer`.
-
 .. toctree::
    :maxdepth: 2
 
    projection
    slice
    volume_render
    tools
-   py-sphviewer
 

format.sh

@@ -20,7 +20,7 @@ fi
 black="./black_formatting_env/bin/python3 -m black"
 
 # Formatting command
-files=$(echo {*.py,tests/*.py,swiftsimio/*.py,swiftsimio/*/*.py,swiftsimio/*/*/*.py})
+files=$(echo {tests/*.py,swiftsimio/*.py,swiftsimio/*/*.py,swiftsimio/*/*/*.py})
 cmd="$black -t py38 $files"
 
 # Print the help

optional_requirements.txt

@@ -2,7 +2,6 @@
 numba
 pytest
 black
-py-sphviewer
 matplotlib
 scipy
 wily

pyproject.toml

@@ -0,0 +1,38 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+packages = ["swiftsimio"]
+
+[project]
+name = "swiftsimio"
+version="6.1.1"
+authors = [
+    { name="Josh Borrow", email="[email protected]" },
+]
+description="SWIFTsim (swift.dur.ac.uk) i/o routines for python."
+readme = "README.md"
+requires-python = ">3.8.0"
+classifiers = [
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "numpy",
+    "h5py",
+    "unyt>=2.9.0",
+    "numba>=0.50.0",
+]
+
+[project.urls]
+"Homepage" = "https://github.com/SWIFTSIM/swiftsimio"
+"Bug Tracker" = "https://github.com/SWIFTSIM/swiftsimio/issues"
+"Documentation" = "https://swiftsimio.readthedocs.io/en/latest"
+
+[project.scripts]
+swiftsnap = "swiftsimio.swiftsnap:swiftsnap"

swiftsimio/optional_packages.py

@@ -5,7 +5,6 @@
 
 + tqdm: progress bars
 + scipy.spatial: KDTrees
-+ sphviewer: visualisation
 + numba/cuda: visualisation
 """
 
@@ -30,16 +29,6 @@ def tqdm(x, *args, **kwargs):
     TREE_AVAILABLE = False
 
 
-# Py-sphviewer
-try:
-    import sphviewer as viewer
-
-    SPHVIEWER_AVAILABLE = True
-except (ImportError, ModuleNotFoundError):
-    viewer = None
-    SPHVIEWER_AVAILABLE = False
-
-
 # Astropy
 try:
     import astropy

swiftsnap → swiftsimio/swiftsnap.py

@@ -60,7 +60,8 @@ def decode(bytestring: bytes) -> str:
     ),
 )
 
-if __name__ == "__main__":
+
+def swiftsnap():
     import swiftsimio as sw
     import unyt
 
@@ -189,3 +190,7 @@ def decode(bytestring: bytes) -> str:
         for name, scheme in data.subgrid_scheme.items():
             if name != "NamedColumns":
                 print(f"{name.replace('Model', 'model')}: {decode(scheme)}")
+
+
+if __name__ == "__main__":
+    swiftsnap()