256 all configs within pyprojecttoml for a streamlined build experience

.github/workflows/python-package.yml

@@ -32,7 +32,7 @@ jobs:
           python -m pip install uv
           uv venv -p  ${{ matrix.python-version }} ${{ matrix.python-version }}
           source ${{ matrix.python-version }}/bin/activate
-          uv pip install -r requirements-dev.txt
+          uv pip install .[dev]
 
       - name: Test with pytest
         if: always()

.github/workflows/release.yml

@@ -17,11 +17,13 @@ jobs:
       with:
         python-version: "3.x"
     - name: Install dependencies
-      run: pip install wheel
-    - name: Build Package
       run: |
-        pip install setuptools 
-        python setup.py sdist bdist_wheel
+        pip install build
+        pip install wheel
+    - name: Build Package
+      run: 
+        python -m build
 
     - name: Publish package distributions to PyPI
       uses: pypa/gh-action-pypi-publish@release/v1
+

CONTRIBUTING.rst

@@ -41,6 +41,25 @@ If working in a codespace the dev requirements and precommit will be installed a
 
 If you are building the documentation locally you will need the `docs/requirements.txt <https://github.com/lvgig/tubular/blob/main/docs/requirements.txt>`_.
 
+Dependencies
+^^^^^^^^^^^^
+A point of surprise for some might be that `requirements.txt` and `requirements-dev.txt` are not user-edited files in this repo -
+they are compiled using `pip-tools= <https://github.com/jazzband/pip-tools?tab=readme-ov-file#example-usage-for-pip-compile>`_ from
+dependencies listed `pyproject.toml`. When adding a new direct dependency, simply add it to the appropriate field inside the package config -
+there is no need to pin it, but you can specify a minimum requirement. Then use `pip-compile <https://medium.com/packagr/using-pip-compile-to-manage-dependencies-in-your-python-packages-8451b21a949e>`_
+to create a pinned set of dependencies, ensuring reproducibility.
+
+`requirements.txt` and `requirements-dev.txt` are still tracked under source control, despite being 'compiled'.
+
+To compile using `pip-tools`:
+
+  .. code::
+
+     pip install pip-tools # optional
+     pip-compile -v --no-emit-index-url --no-emit-trusted-host --output-file requirements.txt  pyproject.toml
+     pip-compile --extra dev -v --no-emit-index-url --no-emit-trusted-host --output-file requirements-dev.txt pyproject.toml
+
+
 General
 ^^^^^^^
 

pyproject.toml

@@ -0,0 +1,135 @@
+[build-system]
+requires = [
+    "setuptools >= 61.0",
+    "wheel",
+    "setuptools-scm[toml]>=6.0"
+   ]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "tubular"
+version = "1.3.1"
+dependencies = [
+    "pandas>=1.5.0",
+    "scikit-learn>=1.2.0"
+]
+requires-python = ">=3.8"
+authors = [{ name = "LV GI Data Science Team", email="#[email protected]"}]
+description = "Package to perform pre processing steps for machine learning models"
+readme = {file = "README.md", content-type = "text/markdown"}
+license = {file = "LICENSE"}
+keywords = ["data science", "feature engineering", "data transforms", "pipeline", "sklearn", "machine learning", "ML", "DS"]
+classifiers=[
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Operating System :: OS Independent",
+    "License :: OSI Approved :: BSD License",
+]
+
+[project.optional-dependencies]
+dev = [
+    "test-aide>=0.1.0",
+    "pytest>=5.4.1",
+    "pytest-mock>=3.5.1",
+    "pytest-cov>=2.10.1",
+    "pre-commit==2.15.0 ",
+    "ruff==0.2.2",
+    ]
+
+[project.urls]
+Documentation = "https://tubular.readthedocs.io/en/latest/index.html"
+Repository = "https://github.com/lvgig/tubular"
+Issues = "https://github.com/lvgig/tubular/issues"
+Changelog = "https://github.com/lvgig/tubular/CHANGELOG.md"
+
+[tool.ruff]
+# Same as Black.
+line-length = 88
+
+# Assume Python 3.8.
+target-version = "py38"
+
+[tool.ruff.lint]
+# Enable the pycodestyle (`E`) and Pyflakes (`F`) rules by default.
+# Unlike Flake8, Ruff doesn't enable pycodestyle warnings (`W`) or
+# McCabe complexity (`C901`) by default.
+select = [
+    "A",
+    "ANN",
+    "ASYNC",
+    "B", # bugbear 
+    "C4",
+    "COM",
+    "DTZ",
+    "E", # pycodestyle
+    "EM",
+    "F", # Pyflakes
+    "FA",
+    "FLY",
+    "I",
+    "INT",
+    "ISC",
+    "NPY",
+    "PD",
+    "PERF",
+    "PGH",
+    "PIE",
+    "PLC",
+    "PLE",
+    "PLW",
+    "PYI",
+    "Q",
+    "RET",
+    "RSE",
+    "S", # Bandit
+    "SIM",
+    "SLOT",
+    "T10",
+    "TCH",
+    "TID",
+    "UP",
+    "W", # pycodestyle warnings
+    "YTT",
+]
+
+# Enabled to allow direct type comparisons using is and is not under E721 (see https://docs.astral.sh/ruff/rules/type-comparison/)
+preview = true
+
+# ignore E501 - linelength limit (covered by black except in docstrings) 
+# and PD901 - use of df variable name
+ignore = ["E501", "PD901", "ANN101"]
+
+# Allow autofix for all enabled rules (when `--fix`) is provided.
+fixable = ["ALL"]
+unfixable = []
+
+# Exclude a variety of commonly ignored directories.
+exclude = [".git", "__pycache__", "build", "dist", "source"]
+
+# Allow unused variables when underscore-prefixed.
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+# Ignore `E402` (import violations) in all `__init__.py` file.
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = ["E402", "F401"]
+"tests/*" = ["ANN", "S101"]
+
+
+[tool.coverage.run]
+branch = true
+
+include = ["tubular/*"]
+
+omit = [
+      "tests/*",
+]
+
+[tool.coverage.report]
+
+show_missing = true
+
+fail_under = 80

requirements-dev.txt

@@ -1,8 +1,79 @@
-test-aide>=0.1.0
-pandas>=1.5.0
-scikit-learn>=1.2.0
-pytest>=5.4.1
-pytest-mock>=3.5.1
-pytest-cov>=2.10.1
-pre-commit==2.15.0 
-ruff==0.2.2
+#
+# This file is autogenerated by pip-compile with Python 3.8
+# by the following command:
+#
+#    pip-compile --extra=dev --no-emit-index-url --no-emit-trusted-host --output-file=requirements-dev.txt pyproject.toml
+#
+cfgv==3.4.0
+    # via pre-commit
+coverage[toml]==7.6.0
+    # via pytest-cov
+distlib==0.3.8
+    # via virtualenv
+exceptiongroup==1.2.2
+    # via pytest
+filelock==3.15.4
+    # via virtualenv
+identify==2.6.0
+    # via pre-commit
+iniconfig==2.0.0
+    # via pytest
+joblib==1.4.2
+    # via scikit-learn
+nodeenv==1.9.1
+    # via pre-commit
+numpy==1.24.4
+    # via
+    #   pandas
+    #   scikit-learn
+    #   scipy
+packaging==24.1
+    # via pytest
+pandas==2.0.3
+    # via tubular (pyproject.toml)
+platformdirs==4.2.2
+    # via virtualenv
+pluggy==1.5.0
+    # via pytest
+pre-commit==2.15.0
+    # via tubular (pyproject.toml)
+pytest==8.2.2
+    # via
+    #   pytest-cov
+    #   pytest-mock
+    #   test-aide
+    #   tubular (pyproject.toml)
+pytest-cov==5.0.0
+    # via tubular (pyproject.toml)
+pytest-mock==3.14.0
+    # via
+    #   test-aide
+    #   tubular (pyproject.toml)
+python-dateutil==2.9.0.post0
+    # via pandas
+pytz==2024.1
+    # via pandas
+pyyaml==6.0.1
+    # via pre-commit
+ruff==0.2.2
+    # via tubular (pyproject.toml)
+scikit-learn==1.3.2
+    # via tubular (pyproject.toml)
+scipy==1.10.1
+    # via scikit-learn
+six==1.16.0
+    # via python-dateutil
+test-aide==0.1.1
+    # via tubular (pyproject.toml)
+threadpoolctl==3.5.0
+    # via scikit-learn
+toml==0.10.2
+    # via pre-commit
+tomli==2.0.1
+    # via
+    #   coverage
+    #   pytest
+tzdata==2024.1
+    # via pandas
+virtualenv==20.26.3
+    # via pre-commit