Merge pull request #22 from sumanjeet0012/feat/modernize-setup

Modernize repository setup: migrate to pyproject.toml, Python 3.10+, GitHub Actions

Author: acul71

.github/workflows/tox.yml

@@ -0,0 +1,68 @@
+name: Run tox
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  tox:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+        toxenv: [core, lint]
+        include:
+          - python-version: "3.10"
+            toxenv: docs
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Set TOXENV
+        run: |
+          if [[ "${{ matrix.toxenv }}" == "docs" ]]; then
+            echo "TOXENV=docs" >> "$GITHUB_ENV"
+          else
+            python_version="${{ matrix.python-version }}"
+            echo "TOXENV=py${python_version//./}-${{ matrix.toxenv }}" >> "$GITHUB_ENV"
+          fi
+      - run: |
+          python -m pip install --upgrade pip
+          python -m pip install "tox>=4.10"
+      - run: |
+          python -m tox run -e "$TOXENV" -r
+
+  windows:
+    runs-on: windows-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+        toxenv: [core, lint]
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Set TOXENV
+        shell: bash
+        run: |
+          python_version="${{ matrix.python-version }}"
+          echo "TOXENV=py${python_version//./}-${{ matrix.toxenv }}" >> "$GITHUB_ENV"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install "tox>=4.10"
+      - name: Test with tox
+        shell: bash
+        run: |
+          python -m tox run -e "$TOXENV" -r

.gitignore

@@ -9,6 +9,7 @@ __pycache__/
 # Distribution / packaging
 .Python
 env/
+venv/
 build/
 develop-eggs/
 dist/

.pre-commit-config.yaml

@@ -0,0 +1,29 @@
+exclude: '.project-template|docs/conf.py|.*pb2\..*'
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-yaml
+      - id: check-toml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.15.0
+    hooks:
+      - id: pyupgrade
+        args: [--py310-plus]
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.10
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format
+  - repo: local
+    hooks:
+      - id: mypy-local
+        name: run mypy with all dev dependencies present
+        entry: mypy -p multicodec
+        language: system
+        always_run: true
+        pass_filenames: false
+        require_serial: false

.readthedocs.yaml

@@ -0,0 +1,24 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.10"
+
+sphinx:
+  configuration: docs/conf.py
+  fail_on_warning: true
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - dev
+
+formats:
+  - epub
+  - htmlzip

.readthedocs.yml

@@ -59,38 +59,77 @@ Get Started!
 
 Ready to contribute? Here's how to set up `multicodec` for local development.
 
-1. Fork the `multicodec` repo on GitHub.
+1. Fork the `py-multicodec` repo on GitHub.
 2. Clone your fork locally::
 
-    $ git clone [email protected]:your_name_here/multicodec.git
+    $ git clone [email protected]:your_name_here/py-multicodec.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 into a virtualenv. Create and activate a virtual environment::
 
-    $ mkvirtualenv multicodec
-    $ cd multicodec/
-    $ python setup.py develop
+    $ python -m venv venv
+    $ source venv/bin/activate  # On Windows: venv\Scripts\activate
+    $ pip install -e ".[dev]"
 
-4. Create a branch for local development::
+4. Install pre-commit hooks (optional but recommended)::
+
+    $ pre-commit install
+
+   This will set up git hooks to automatically run linting and formatting checks
+   before each commit.
+
+5. 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::
+6. When you're done making changes, check that your changes pass linting and the
+   tests, including testing other Python versions with tox::
 
-    $ flake8 multicodec tests
-    $ python setup.py test or py.test
+    $ make lint
+    $ make test
     $ tox
 
-   To get flake8 and tox, just pip install them into your virtualenv.
+   Or run pre-commit manually on all files::
+
+    $ pre-commit run --all-files
+
+   If you installed pre-commit hooks (step 4), they will run automatically on commit.
+
+Development Workflow Commands
+-------------------------------
+
+The project provides several ``make`` targets to help with development:
+
+* ``make fix`` - Automatically fix formatting and linting issues using ruff.
+  Use this when you want to auto-fix code style issues.
 
-6. Commit your changes and push your branch to GitHub::
+* ``make lint`` - Run all pre-commit hooks on all files to check for code quality
+  issues. This includes YAML/TOML validation, trailing whitespace checks, pyupgrade,
+  ruff linting and formatting, and mypy type checking.
+
+* ``make typecheck`` - Run mypy type checking only. Use this when you want to
+  quickly check for type errors without running all other checks.
+
+* ``make test`` - Run the test suite with pytest using the default Python version.
+  For testing across multiple Python versions, use ``tox`` instead.
+
+* ``make pr`` - Run a complete pre-PR check: clean build artifacts, fix formatting,
+  run linting, type checking, and tests. This is the recommended command to run
+  before submitting a pull request.
+
+* ``make coverage`` - Run tests with coverage reporting and open the HTML report
+  in your browser.
+
+For a full list of available commands, run ``make help``.
+
+7. Commit your changes and push your branch to GitHub::
 
     $ git add .
     $ git commit -m "Your detailed description of your changes."
-    $ git push origin name-of-your-bugfix-or-feature
+    $ git push -u origin name-of-your-bugfix-or-feature
 
-7. Submit a pull request through the GitHub website.
+8. Submit a pull request through the GitHub website.
 
 Pull Request Guidelines
 -----------------------
@@ -101,14 +140,17 @@ 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.rst.
-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/multiformats/py-multicodec/pull_requests
+3. The pull request should work for Python 3.10, 3.11, 3.12, 3.13, and 3.14. Check
+   https://github.com/multiformats/py-multicodec/actions
    and make sure that the tests pass for all supported Python versions.
 
 Tips
 ----
 
 To run a subset of tests::
 
-$ py.test tests.test_multicodec
+    $ pytest tests/test_multicodec.py
+
+To run tests with coverage::
 
+    $ make coverage

.travis.yml

@@ -8,4 +8,3 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-