Merge pull request #156 from pymc-labs/pyproject

`setup.py` is dead, long live `pyproject.toml`

Author: drbenvincent

.isort.cfg

@@ -25,8 +25,15 @@ pip install -e .
 4. Install development dependencies
 
 ```
-pip install -r requirements-dev.txt
-pip install -r requirements-docs.txt
+pip install causalpy[dev]
+pip install causalpy[docs]
+```
+
+If that fails, try:
+
+```
+pip install 'causalpy[dev]'
+pip install 'causalpy[docs]'
 ```
 
 It may also be necessary to [install](https://pandoc.org/installing.html) `pandoc`. On a mac, I run `brew install pandoc`.
@@ -54,7 +61,7 @@ cd docs
 make html
 ```
 
-Sometimes not all changes are recognised. In that case run:
+Sometimes not all changes are recognised. In that case run this (again from within the `docs` folder):
 
 ```bash
 make clean && make html
@@ -70,16 +77,16 @@ The `.readthedocs.yaml` file contains the configurations for the remote build.
 
 If there are autodoc issues/errors in remote builds of the docs, we need to add all package dependencies (in `requirements.txt`) into the list `autodoc_mock_imports` in `docs/config.py`.
 
-## New releases [work in progress]
+## New releases
 
 ### Test release to `test.pypi.org` (manual)
 
-1. Bump the release version in `causalpy/version.py`. This is automatically read by `setup.py` and `docs/config.py`.
-2. Build locally and upload to test.pypi.org. _Note that this requires username and password for test.pypi.org_. In the root directory type the following:
+1. Bump the release version in `causalpy/version.py` and `pyproject.toml`.
+2. Build locally and upload to test.pypi.org. Full instructions here https://packaging.python.org/en/latest/tutorials/packaging-projects/. _Note that this requires username and password for test.pypi.org_. In the root directory type the following:
 ```bash
 rm -rf dist
-python setup.py sdist
-twine upload --repository testpypi dist/*
+python3 -m build
+python3 -m twine upload --repository testpypi dist/*
 ```
 3. At this point the updated build is available on test.pypi.org. We can test that this is working as expected by installing (into a test environment) from test.pypi.org with
 
@@ -93,14 +100,14 @@ python3 -m pip install --index-url https://test.pypi.org/simple/ --extra-index-u
 
 ### Actual release to `pypi.org` (manual)
 
-1. Bump the release version (if not done in the previous step) in `causalpy/version.py`. This is automatically read by `setup.py` and `docs/config.py`.
+1. Bump the release version in `causalpy/version.py` and `pyproject.toml` (if not done in the previous step). This is automatically read by `setup.py` and `docs/config.py`.
 2. Push this to a branch, open a pull request, and merge into main.
 3. Manually draft a new release [here](https://github.com/pymc-labs/CausalPy/releases), making sure to hit 'generate release notes'.
 4. Build locally and upload to pypi.org. In the root directory:
 ```bash
 rm -rf dist
-python setup.py sdist
-twine upload dist/*
+python3 -m build
+python3 -m twine upload dist/*
 ```
 5. Readthedocs:
   - Docs should be built remotely every time there is a pull request

CONTRIBUTING.md

@@ -4,12 +4,12 @@ init:
 	python -m pip install -e .
 
 lint:
-	pip install -r requirements-lint.txt
+	pip install causalpy[lint]
 	isort .
 	black .
 
 check_lint:
-	pip install -r requirements-lint.txt
+	pip install causalpy[lint]
 	flake8 .
 	isort --check-only .
 	black --diff --check --fast .
@@ -18,5 +18,5 @@ check_lint:
 	interrogate .
 
 test:
-	pip install -r requirements-test.txt
+	pip install causalpy[test]
 	pytest

Makefile

@@ -1 +1 @@
-__version__ = "0.0.9"
+__version__ = "0.0.10b"

causalpy/version.py

@@ -1,5 +1,95 @@
+[build-system]
+# Minimum requirements for the build system to execute.
+build-backend = "setuptools.build_meta"
+requires = ["setuptools>=61.0"]
+
+# This is configuration specific to the `setuptools` build backend.
+# If you are using a different build backend, you will need to change this.
+[tool.setuptools]
+# define all packages here
+packages = ['causalpy', 'causalpy.data']
+
+[project]
+name = "CausalPy"
+version = "0.0.10b"
+description = "Causal inference for quasi-experiments in Python"
+readme = "README.md"
+license = {file = "LICENSE"}
+authors = [{ name = "Ben Vincent", email = "[email protected]" }]
+requires-python = ">=3.8"
+
+# This field lists other packages that your project depends on to run.
+# Any package you put here will be installed by pip when your project is
+# installed, so they must be valid existing projects.
+#
+# For an analysis of this field vs pip's requirements files see:
+# https://packaging.python.org/discussions/install-requires-vs-requirements/
+dependencies = [
+    "arviz>=0.14.0",
+    "graphviz",
+    "ipython!=8.7.0",
+    "matplotlib>=3.5.3",
+    "numpy",
+    "pandas",
+    "patsy",
+    "pymc>=5.0.0",
+    "scikit-learn>=1",
+    "scipy",
+    "seaborn>=0.11.2",
+    "xarray>=v2022.11.0",
+]
+
+# List additional groups of dependencies here (e.g. development dependencies). Users
+# will be able to install these using the "extras" syntax, for example:
+#
+#   $ pip install causalpy[dev]
+#
+# Similar to `dependencies` above, these must be valid existing projects.
+[project.optional-dependencies]
+dev = [
+    "pathlib",
+    "pre-commit",
+    "twine",
+    "interrogate",
+    ]
+docs = ["ipykernel",
+    "linkify-it-py",
+    "myst_parser",
+    "nbsphinx",
+    "pathlib",
+    "sphinx",
+    "sphinx-autodoc-typehints",
+    "sphinx-design",
+    "sphinx-rtd-theme",
+    "statsmodels",
+    ]
+lint = ["black",
+    "flake8",
+    "interrogate",
+    "isort",
+    "nbqa",
+    "pre-commit"
+    ]
+test = [
+    "pytest",
+    "pytest-cov",
+    ]
+
+[metadata]
+description-file = 'README.md'
+license_files = 'LICENSE'
+
+[project.urls]
+Homepage = "https://github.com/pymc-labs/CausalPy"
+"Bug Reports" = "https://github.com/pymc-labs/CausalPy/issues"
+"Source" = "https://github.com/pymc-labs/CausalPy"
+
+[tool.black]
+line_length = 88
+
 [tool.isort]
 profile = "black"
+skip_gitignore = true
 
 [tool.pytest.ini_options]
 addopts = [