Modernize package (#306)

* Modernize package

* Apply ruff formatting

* Ignore typing

* Additional updates

* Move to hatchling!

* Use pypi OIDC

* Fix failing github actions

* Update changelog

Author: fhightower

.github/workflows/ci.yml

@@ -10,6 +10,19 @@ on:
     branches: [ main ]
 
 jobs:
+  build_smoke:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python 3.14
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.14'
+    - name: Set up uv
+      uses: astral-sh/setup-uv@v6
+    - name: Build package
+      run: uv build
+
   build_multi_os:
     runs-on: ${{ matrix.os }}
     strategy:
@@ -23,16 +36,16 @@ jobs:
       uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
+    - name: Set up uv
+      uses: astral-sh/setup-uv@v6
     - name: Install dependencies
-      run: |
-        python -m pip install -r requirements.txt
-        python -m pip install -r requirements_dev.txt
+      run: uv sync --locked --group dev
     - name: Run pytest
       run: |
-        pytest
-        codecov
+        uv run pytest
+        uv run codecov
         # run benchmark tests
-        pytest -c "." --benchmark-storage=.benchmarks/${{ runner.os == 'macOS' && 'Darwin' || runner.os }}-CPython-${{ matrix.python-version }}-64bit/ --benchmark-compare=0001 --benchmark-compare-fail=mean:10% --benchmark-columns='mean,median,stddev,iqr' tests/benchmarks.py
+        uv run pytest -c "." --benchmark-storage=.benchmarks/${{ runner.os == 'macOS' && 'Darwin' || runner.os }}-CPython-${{ matrix.python-version }}-64bit/ --benchmark-compare=0001 --benchmark-compare-fail=mean:15% --benchmark-columns='mean,median,stddev,iqr' tests/benchmarks.py
 
   build_multi_py_versions:
     runs-on: ${{ matrix.os }}
@@ -47,11 +60,11 @@ jobs:
       uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
+    - name: Set up uv
+      uses: astral-sh/setup-uv@v6
     - name: Install dependencies
-      run: |
-        python -m pip install -r requirements.txt
-        python -m pip install -r requirements_dev.txt
+      run: uv sync --locked --group dev
     - name: Run pytest
       run: |
-        pytest
-        codecov
+        uv run pytest
+        uv run codecov

.github/workflows/lint.yml

@@ -18,10 +18,10 @@ jobs:
       uses: actions/setup-python@v5
       with:
         python-version: '3.14'
+    - name: Set up uv
+      uses: astral-sh/setup-uv@v6
     - name: Install dependencies
-      run: |
-        python -m pip install -r requirements.txt
-        python -m pip install -r requirements_dev.txt
+      run: uv sync --locked --group dev
     - name: Lint
       env:
         CONTEXT: ci

.github/workflows/python-publish.yml

@@ -1,5 +1,6 @@
-# This workflow will upload a Python Package using Twine when a release is created
-# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+# This workflow will upload a Python Package to PyPI when a release is created
+# Uses PyPI trusted publishing (OIDC) — no secrets required.
+# Configure at: https://pypi.org/manage/project/ioc-finder/settings/publishing/
 
 name: Upload Python Package to PyPi
 
@@ -13,6 +14,10 @@ jobs:
 
     runs-on: ubuntu-latest
 
+    permissions:
+      id-token: write   # required for OIDC trusted publishing
+      contents: read
+
     steps:
     - uses: actions/checkout@v4
       with:
@@ -25,14 +30,9 @@ jobs:
       uses: actions/setup-python@v5
       with:
         python-version: '3.x'
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install setuptools wheel twine
-    - name: Build and publish
-      env:
-        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
-        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
-      run: |
-        python setup.py sdist bdist_wheel
-        twine upload dist/*
+    - name: Set up uv
+      uses: astral-sh/setup-uv@v6
+    - name: Build
+      run: uv build
+    - name: Publish to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/windows-benchmark-baseline.yml

@@ -31,15 +31,16 @@ jobs:
         with:
           python-version: ${{ env.PYTHON_VERSION }}
 
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v6
+
       - name: Install dependencies
-        run: |
-          python -m pip install -r requirements.txt
-          python -m pip install -r requirements_dev.txt
+        run: uv sync --locked --group dev
 
       - name: Generate benchmark baseline
         shell: pwsh
         run: |
-          pytest -c "." --benchmark-storage=.benchmarks/ --benchmark-save=benchmark tests/benchmarks.py
+          uv run pytest -c "." --benchmark-storage=.benchmarks/ --benchmark-save=benchmark tests/benchmarks.py
 
           $benchDir = ".benchmarks/Windows-CPython-${{ env.PYTHON_VERSION }}-64bit"
           if (-not (Test-Path $benchDir)) {

.gitignore

@@ -9,6 +9,7 @@ __pycache__/
 # Distribution / packaging
 .Python
 env/
+.venv/
 build/
 develop-eggs/
 dist/
@@ -65,3 +66,5 @@ target/
 travis_pypi_setup.py
 Pipfile
 Pipfile.lock
+
+.DS_Store

CHANGELOG.md

@@ -30,6 +30,17 @@ which are unliklely to be found in the wild
 ### Removed
 
 - Formal support for Python < 3.10
+- `setup.py`, `setup.cfg`, and `mypy.ini` (configuration consolidated into `pyproject.toml`)
+
+### Changed
+
+- Migrated from pip/setuptools to uv for dependency management and packaging
+- Switched build backend from setuptools to hatchling
+- Replaced flake8, black, isort, and pylint with ruff for linting and formatting
+- Switched PyPI publishing to trusted publishing (OIDC) — no more username/password secrets
+- Updated Dockerfile base image from `python:3.10.2-buster` to `python:3.14-slim-bookworm`
+- Updated CI, Docker, Makefile, and docs to use uv throughout
+- Relaxed benchmark regression threshold from 10% to 15% to reduce flaky CI failures
 
 ## [7.3.0] - 2022.12.22
 

CONTRIBUTING.rst

@@ -64,25 +64,21 @@ Ready to contribute? Here's how to set up `ioc_finder` for local development.
 
     $ git clone [email protected]:<your_github_username_here>/ioc_finder.git
 
-3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
+3. Install your local copy. Install `uv <https://docs.astral.sh/uv/>`_ then set up your fork for local development::
 
-    $ mkvirtualenv ioc_finder
     $ cd ioc_finder/
-    $ python setup.py develop
+    $ uv sync --locked --group dev
 
 4. Create a branch for local development::
 
     $ git checkout -b name-of-your-bugfix-or-feature
 
    Now you can make your changes locally.
 
-5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::
+5. When you're done making changes, check that your changes pass linting and the tests::
 
-    $ flake8 ioc_finder tests
-    $ python setup.py test or py.test
-    $ tox
-
-   To get flake8 and tox, just pip install them into your virtualenv.
+    $ uv run ruff check ioc_finder tests
+    $ uv run pytest
 
 6. Commit your changes and push your branch to GitHub::
 
@@ -101,8 +97,7 @@ Before you submit a pull request, check that it meets these guidelines:
 2. If the pull request adds functionality, the docs should be updated. Put
    your new functionality into a function with a docstring, and add the
    feature to the list in README.md.
-3. The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check
-   https://travis-ci.org/fhightower/ioc-finder/pull_requests
+3. The pull request should work for Python 3.10+. Check the GitHub Actions CI
    and make sure that the tests pass for all supported Python versions.
 
 Tips
@@ -111,4 +106,3 @@ Tips
 To run a subset of tests::
 
 $ py.test tests.test_ioc_finder
-

Dockerfile

@@ -1,9 +1,11 @@
-FROM python:3.10.2-buster
+FROM python:3.14-slim-bookworm
 
-ENV PIP_NO_CACHE_DIR "true"
+ENV UV_LINK_MODE=copy
 
-COPY ./requirements*.txt /code/
+COPY --from=ghcr.io/astral-sh/uv:0.9.28 /uv /uvx /bin/
 
 WORKDIR /code
 
-RUN pip install -r requirements.txt -r requirements_dev.txt
+COPY . /code
+
+RUN uv sync --locked --group dev

Makefile

@@ -1,4 +1,4 @@
-.PHONY: clean clean-test clean-pyc clean-build docs help
+.PHONY: clean clean-test clean-pyc clean-build docs help init install lint test test-all coverage dist pypi export-requirements
 .DEFAULT_GOAL := help
 define BROWSER_PYSCRIPT
 import os, webbrowser, sys
@@ -26,6 +26,8 @@ BROWSER := python -c "$$BROWSER_PYSCRIPT"
 help:
 	@python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)
 
+UV := uv
+
 clean: clean-build clean-pyc clean-test ## remove all build, test, coverage and Python artifacts
 
 
@@ -47,21 +49,22 @@ clean-test: ## remove test and coverage artifacts
 	rm -f .coverage
 	rm -fr htmlcov/
 
-lint: ## check style with flake8
-	flake8 ioc_finder tests
+lint: ## check style with ruff and mypy
+	$(UV) run ruff check ioc_finder tests
+	$(UV) run mypy ioc_finder tests
 
 test: ## run tests quickly with the default Python
-	py.test
+	$(UV) run pytest
 
 
 test-all: ## run tests on every Python version with tox
-	tox
+	$(UV) run pytest
 
 coverage: ## check code coverage quickly with the default Python
-	coverage run --source ioc_finder -m pytest
+	$(UV) run coverage run --source ioc_finder -m pytest
 
-		coverage report -m
-		coverage html
+		$(UV) run coverage report -m
+		$(UV) run coverage html
 		$(BROWSER) htmlcov/index.html
 
 docs: ## generate Sphinx HTML documentation, including API docs
@@ -76,26 +79,26 @@ servedocs: docs ## compile the docs watching for changes
 	watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .
 
 release: clean ## package and upload a release
-	python setup.py sdist upload
-	python setup.py bdist_wheel upload
+	$(UV) build
+	$(UV) publish
 
 dist: clean ## builds source and wheel package
-	python setup.py sdist
-	python setup.py bdist_wheel
+	$(UV) build
 	ls -l dist
 
 install: clean ## install the package to the active Python's site-packages
-	python setup.py install
+	$(UV) sync --locked --group dev
 
 upstream: ## set the upstream for the repository
 	git remote set-upstream https://github.com/fhightower/ioc-finder.git
 
-init: ## install the development requirements with pip (related to python2.x)
-	pip install -r requirements_dev.txt
+init: ## install the project and development requirements with uv
+	$(UV) sync --locked --group dev
 
-init3: ## install the development requirements with pip3 (related to python3.x)
-	pip3 install -r requirements_dev.txt
+export-requirements: ## regenerate compatibility requirements files from pyproject.toml
+	$(UV) export --frozen --no-hashes --no-emit-project --format requirements-txt --no-dev -o requirements.txt
+	$(UV) export --frozen --no-hashes --no-emit-project --format requirements-txt --all-groups -o requirements_dev.txt
 
 pypi: clean ## upload the code to pypi
-	python3 setup.py sdist bdist_wheel
-	python3 -m twine upload dist/*
+	$(UV) build
+	$(UV) publish

docker-compose.yml

@@ -12,41 +12,28 @@ services:
 
   dev:
     <<: *base
-    command: ipython
+    command: uv run ipython
 
   mkdocs:
     <<: *base
-    entrypoint: "mkdocs"
     ports:
       - "8000:8000"
-    command: ["serve", "--dev-addr=0.0.0.0:8000"]
-
-  bump-patch:
-    <<: *base
-    command: bumpversion patch
-
-  bump-minor:
-    <<: *base
-    command: bumpversion minor
-
-  bump-major:
-    <<: *base
-    command: bumpversion major
+    command: ["uv", "run", "mkdocs", "serve", "--dev-addr=0.0.0.0:8000"]
 
   test:
     <<: *base
-    command: pytest
+    command: uv run pytest
 
   test-benchmarks:
     <<: *base
     # the `-c "."` prevents pytest from using the config specified in the pyproject.toml (which we don't want to use for benchmarks)
-    command: pytest -c "." --benchmark-storage=.benchmarks/Linux-CPython-3.10-64bit/ --benchmark-compare=0001 --benchmark-compare-fail=mean:10% --benchmark-columns='mean,median,stddev,iqr' tests/benchmarks.py
+    command: uv run pytest -c "." --benchmark-storage=.benchmarks/Linux-CPython-3.10-64bit/ --benchmark-compare=0001 --benchmark-compare-fail=mean:15% --benchmark-columns='mean,median,stddev,iqr' tests/benchmarks.py
 
   update-benchmarks:
     <<: *base
     command: >
       bash -c "
-        pytest -c '.' --benchmark-storage=.benchmarks/ --benchmark-save=benchmark tests/benchmarks.py &&
+        uv run pytest -c '.' --benchmark-storage=.benchmarks/ --benchmark-save=benchmark tests/benchmarks.py &&
         mv .benchmarks/Linux-CPython-3.10-64bit/0002_benchmark.json .benchmarks/Linux-CPython-3.10-64bit/0001_benchmark.json"
 
   lint: