NT: Update build process to use pyproject.toml (#7)

* update build process to use pyproject.toml

* pr review changes

Author: BartoszBlizniak

.github/workflows/ci.yml

@@ -25,8 +25,8 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install -e ".[test]"
-          pip install flake8 black
+          pip install -e .[test]
+          pip install flake8 black build
 
       - name: Format code with Black (non-blocking)
         run: |
@@ -43,6 +43,11 @@ jobs:
         run: |
           python -m pytest tests/ -v --cov=plugin --cov-report=xml
 
+      - name: Build package
+        run: |
+          python -m build
+          ls -1 dist
+
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v3
         with:

.github/workflows/release.yml

@@ -21,6 +21,8 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
@@ -29,19 +31,8 @@ jobs:
       - name: Install build tooling
         run: |
           python -m pip install --upgrade pip
-          pip install build wheel setuptools
+          pip install build wheel setuptools setuptools-scm
 
-      - name: Verify version matches tag
-        shell: bash
-        run: |
-          set -euo pipefail
-          TAG_VERSION="${GITHUB_REF_NAME#v}"
-          PKG_VERSION=$(python setup.py --version)
-          echo "Package version: ${PKG_VERSION} | Tag version: ${TAG_VERSION}"
-          test "${PKG_VERSION}" = "${TAG_VERSION}" || {
-            echo "Version mismatch: setup.py (${PKG_VERSION}) != tag (${TAG_VERSION})"
-            exit 1
-          }
 
       - name: Build package (sdist + wheel)
         run: |

.gitignore

@@ -1,138 +1,10 @@
-# Byte-compiled / optimized / DLL files
-__pycache__/
-*.py[cod]
-*$py.class
+# Local virtual environment
+.venv/
 
-# C extensions
-*.so
-
-# Distribution / packaging
-.Python
-build/
-develop-eggs/
+# Build outputs
 dist/
-downloads/
-eggs/
-.eggs/
-lib/
-lib64/
-parts/
-sdist/
-var/
-wheels/
-*.egg-info/
-.installed.cfg
-*.egg
-MANIFEST
-*.tar.gz
-*.whl
-
-# PyInstaller
-*.manifest
-*.spec
-
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
-
-# Unit test / coverage reports
-htmlcov/
-.tox/
-.nox/
-.coverage
-.coverage.*
-.cache
-nosetests.xml
-coverage.xml
-*.cover
-.hypothesis/
-.pytest_cache/
-
-# Translations
-*.mo
-*.pot
-
-# Django stuff:
-*.log
-local_settings.py
-db.sqlite3
-
-# Flask stuff:
-instance/
-.webassets-cache
-
-# Scrapy stuff:
-.scrapy
-
-# Sphinx documentation
-docs/_build/
-
-# PyBuilder
-target/
-
-# Jupyter Notebook
-.ipynb_checkpoints
-
-# IPython
-profile_default/
-ipython_config.py
+mlflow_cloudsmith_plugin.egg-info/
 
-# pyenv
-.python-version
-
-# celery beat schedule file
-celerybeat-schedule
-
-# SageMath parsed files
-*.sage.py
-
-# Environments
-.env
-.venv
-env/
-venv/
-ENV/
-env.bak/
-venv.bak/
-.python-venv/
-.direnv/
-
-# Spyder project settings
-.spyderproject
-.spyproject
-
-# Rope project settings
-.ropeproject
-
-# mkdocs documentation
-/site
-
-# mypy
-.mypy_cache/
-.dmypy.json
-dmypy.json
-
-# Pyre type checker
-.pyre/
-
-# IDEs
-.vscode/
-.idea/
-*.swp
-*.swo
-*~
-.DS_Store
-.AppleDouble
-.LSOverride
-
-# OS
-.DS_Store
-Thumbs.db
-
-# Project specific
-config_settings.conf
-demo_output/
-*.tmp
-*.log
-*.local
-*.env.local
+# Python bytecode
+__pycache__/
+*.py[cod]

CONTRIBUTING.md

@@ -0,0 +1,35 @@
+## Contributing
+
+We welcome contributions!
+
+**Setup**
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+pip install -e '.[dev]'
+```
+
+**Run Checks**
+
+```bash
+# Lint & Format
+flake8 plugin
+black --check plugin tests
+
+# Tests
+pytest -q
+```
+
+---
+
+## Continuous Integration
+
+* **GitHub Actions** runs:
+
+  * `flake8`
+  * `black --check`
+  * `pytest` (with coverage)
+* Python versions: **3.8–3.12**
+
+---

MANIFEST.in

@@ -53,6 +53,15 @@ repo.log_artifact("model.pkl", "models/production")
 for info in repo.list_artifacts("models"):
     print(info.path, info.file_size, info.is_dir)
 ```
+### Example startup:
+
+```bash
+mlflow server \
+  --host 127.0.0.1 \
+  --port 5000 \
+  --artifacts-destination cloudsmith://<CLOUDSMITH_NAMESPACE>/<CLOUDSMITH_REPO>
+```
+
 
 ---
 
@@ -187,37 +196,7 @@ CLOUDSMITH_API_KEY="" CLOUDSMITH_OWNER=myorg CLOUDSMITH_REPO=myrepo \
 
 ## Contributing
 
-We welcome contributions!
-
-**Setup**
-
-```bash
-# Create & activate virtual environment
-pip install -e .
-pip install -r requirements.txt
-```
-
-**Run Checks**
-
-```bash
-# Lint & Format
-flake8 plugin
-black --check plugin tests
-
-# Tests
-pytest -q
-```
-
----
-
-## Continuous Integration
-
-* **GitHub Actions** runs:
-
-  * `flake8`
-  * `black --check`
-  * `pytest` (with coverage)
-* Python versions: **3.8–3.12**
+We welcome contributions! Please see [CONTRIBUTING](CONTRIBUTING.md) for more details.
 
 ---
 

README.md

@@ -0,0 +1,70 @@
+[build-system]
+requires = ["setuptools>=69", "wheel", "setuptools-scm>=8"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "mlflow-cloudsmith-plugin"
+dynamic = ["version"]
+description = "MLflow plugin for storing artifacts in Cloudsmith repositories"
+readme = "README.md"
+license = { file = "LICENSE" }
+authors = [{ name = "Cloudsmith Customer Engineering", email = "support@cloudsmith.com" }]
+requires-python = ">=3.8"
+dependencies = [
+    "requests>=2.25.0",
+    "mlflow>=2.12.0",
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Programming Language :: Python :: 3",
+]
+
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=6.0",
+    "pytest-cov>=2.0",
+    "black>=22.0",
+    "flake8>=4.0",
+    "mypy>=0.950",
+    "build>=1.0.0",
+]
+test = ["pytest>=6.0", "pytest-cov>=2.0"]
+
+[project.entry-points."mlflow.artifact_repository"]
+cloudsmith = "plugin.cloudsmith_repository:CloudsmithArtifactRepository"
+
+[project.urls]
+"Source" = "https://github.com/cloudsmith-io/mlflow-cloudsmith-plugin"
+"Bug Tracker" = "https://github.com/cloudsmith-io/mlflow-cloudsmith-plugin/issues"
+"Documentation" = "https://github.com/cloudsmith-io/mlflow-cloudsmith-plugin#readme"
+
+[tool.setuptools]
+packages = { find = { exclude = ["tests", "tests.*"] } }
+
+[tool.setuptools_scm]
+version_scheme = "release-branch-semver"
+local_scheme = "no-local-version"
+fallback_version = "0.0.0"
+
+[tool.pytest.ini_options]
+addopts = "-ra --cov=plugin --cov-report=term-missing"
+testpaths = ["tests"]
+filterwarnings = [
+    "ignore:Failure attempting to register artifact repository for scheme \"cloudsmith\":UserWarning",
+]
+
+[tool.black]
+line-length = 100
+target-version = ["py38"]
+
+[tool.flake8]
+max-line-length = 100
+extend-ignore = ["E203"]
+
+[tool.mypy]
+python_version = "3.8"
+warn_unused_ignores = true
+warn_return_any = true
+warn_redundant_casts = true
+warn_unreachable = true