Merge pull request #33 from matagus/more-repo-improvements-2

Improvements to README, pyproject.toml and CI workflow config

Author: matagus

.github/workflows/ci.yml

@@ -17,12 +17,8 @@ jobs:
         django-version: ["4.2", "5.0", "5.1", "5.2"]
         os: [ubuntu-latest]
         exclude:
-          - django-version: "5.0"
-            python-version: "3.10"
-          - django-version: "5.0"
-            python-version: "3.11"
-          - django-version: "5.0"
-            python-version: "3.12"
+          - django-version: "4.2"
+            python-version: "3.13"
           - django-version: "5.0"
             python-version: "3.13"
     runs-on: ${{ matrix.os }}
@@ -32,9 +28,24 @@ jobs:
         uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Install dependencies
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          enable-cache: true
+          cache-dependency-glob: "pyproject.toml"
+      - name: Cache hatch environments
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.local/share/hatch
+            ~/.cache/hatch
+          key: hatch-${{ runner.os }}-py${{ matrix.python-version }}-django${{ matrix.django-version }}-${{ hashFiles('pyproject.toml') }}
+          restore-keys: |
+            hatch-${{ runner.os }}-py${{ matrix.python-version }}-django${{ matrix.django-version }}-
+            hatch-${{ runner.os }}-py${{ matrix.python-version }}-
+      - name: Install hatch with uv
         run: |
-          python -m pip install --upgrade hatch
+          uv tool install hatch
       - name: Run tests for Python ${{ matrix.python-version }} and Django ${{ matrix.django-version }} on ${{ matrix.os }} with coverage report
         run: |
           hatch run test.py${{ matrix.python-version }}-${{ matrix.django-version }}:cov

README.md

@@ -1,9 +1,14 @@
 django-pagination-py3
 ====================
 
-![Python Compatibility](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue.svg) [![PyPi Version](https://img.shields.io/pypi/v/django-pagination-py3.svg)](https://pypi.python.org/pypi/django-pagination-py3)  ![CI badge](https://github.com/matagus/django-pagination-py3/actions/workflows/ci.yml/badge.svg) [![codecov](https://codecov.io/gh/matagus/django-pagination-py3/graph/badge.svg?token=a64SxEDQk0)](https://codecov.io/gh/matagus/django-pagination-py3) [![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
+![Python Compatibility](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue.svg)
+![Django Compatibility](https://img.shields.io/badge/django-4.2%20|%205.0%20|%205.1%20|%205.2-%2344B78B?labelColor=%23092E20)
+[![PyPi Version](https://img.shields.io/pypi/v/django-pagination-py3.svg)](https://pypi.python.org/pypi/django-pagination-py3)
+![CI badge](https://github.com/matagus/django-pagination-py3/actions/workflows/ci.yml/badge.svg)
+[![codecov](https://codecov.io/gh/matagus/django-pagination-py3/graph/badge.svg?token=a64SxEDQk0)](https://codecov.io/gh/matagus/django-pagination-py3)
+[![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
 
-A port of [ericflo/django-pagination](https://github.com/ericflo/django-pagination) to Python 3. Updated to be compatible with Django 4.x and 5.x.
+A port of [ericflo/django-pagination](https://github.com/ericflo/django-pagination) to Python 3. Updated to be compatible with Django 4.2 to 5.2.
 
 For versions compatible with Django 3.x and Python 2.7+ please install or download version `1.2.0` from [Releases](https://github.com/matagus/django-pagination-py3/releases) or
 [Pypi](https://pypi.org/project/django-pagination-py3/).
@@ -35,7 +40,7 @@ cd django-pagination-py3
 pip install -e .
 ```
 
-Add `pagination` INSTALLED_APPS to your `settings.py`:
+Add `pagination` to INSTALLED_APPS in your `settings.py`:
 
 ```python
 INSTALLED_APPS = (
@@ -103,7 +108,7 @@ Running Tests
 License
 =======
 
-`django-pagination-py3` is released under an BSD License - see the `LICENSE` file for more information.
+`django-pagination-py3` is released under a BSD License - see the `LICENSE` file for more information.
 
 
 Acknowledgements

pyproject.toml

@@ -7,7 +7,7 @@ name = "django-pagination-py3"
 dynamic = ["version"]
 description = "A port of ericflo/django-pagination to Python 3 and beyond!"
 readme = "README.md"
-license = "BSD-2-clause"
+license = "BSD-2-Clause"
 authors = [
     { name = "Agustin Mendez", email = "matagus@gmail.com" },
 ]