Modernize packaging and CI (pyproject.toml, Tox, GHA)

.github/workflows/pipeline.yml

@@ -0,0 +1,65 @@
+name: Pipeline
+on:
+  pull_request:
+    branches:
+    - main
+  push:
+    branches:
+    - main
+    tags:
+    - '[0-9]+.[0-9]+.[0-9]+'
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        env:
+        - lint
+        - format
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+      with:
+        python-version: '3.12'
+    - run: pip install tox
+    - run: tox run -e ${{ matrix.env }}
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version:
+        - '3.10'
+        - '3.11'
+        - '3.12'
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - run: pip install tox
+    - run: tox run -e py
+
+  publish:
+    if: startsWith(github.ref, 'refs/tags/')
+    needs:
+    - check
+    - test
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+      with:
+        python-version: '3.12'
+    - name: Install build tools
+      run: pip install tox
+    - name: Verify package version is same as Git tag
+      run: tox run -qe ensure_version_matches -- $GIT_TAG
+      env:
+        GIT_TAG: ${{ github.ref_name }}
+    - name: Build package and upload to PyPI
+      run: tox run -e package -- upload
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}

.gitignore

@@ -1,6 +1,8 @@
+# Bytecode
 *.py[co]
 
 # Packages
+django_bootstrap_static-*/
 *.egg
 *.egg-info
 dist
@@ -20,10 +22,10 @@ pip-log.txt
 .coverage
 .tox
 
-#Translations
+# Translations
 *.mo
 
-#Mr Developer
+# Mr Developer
 .mr.developer.cfg
 .idea
-*.DS_Store
+*.DS_Store

AUTHORS.rst

@@ -1,8 +1,7 @@
 Maintainers
 -----------
 
-* Derek Stegelman (@dstegelman), original author
-* Peter Bittner (@bittner), current maintainer
+* Peter Bittner (@bittner)
 
 Contributors
 ------------
@@ -11,3 +10,10 @@ Contributors
 * Aaron VanDerlip (@aaronvanderlip)
 * Travis Swicegood (@tswicegood)
 * Pablo Castellano (@PabloCastellano)
+* Amit Kumar (@umrao-ak47)
+* Wolfgang Herget (@wherget)
+
+Original Author
+---------------
+
+* Derek Stegelman (@dstegelman)

MANIFEST.in

@@ -1,3 +1,6 @@
+graft bootstrap/static
+graft fontawesome/static
+exclude .gitignore tox.ini
 include README.rst
-recursive-include bootstrap/static *.*
-recursive-include fontawesome/static *.*
+prune .github
+prune tests

README.rst

@@ -2,7 +2,7 @@
 Django Bootstrap Static Files |latest-version|
 ==============================================
 
-|bootstrap| |jquery| |fontawesome| |build-status|
+|bootstrap| |jquery| |fontawesome| |pipeline|
 
 Bootstrap and optional Font Awesome static files ready for the picking.
 
@@ -20,9 +20,9 @@ Also ships the latest jQuery compatible with Bootstrap, for optional inclusion.
 .. |fontawesome| image:: https://img.shields.io/badge/Font_Awesome-v6.5.2-1c9a71.svg
    :alt: Font Awesome 6.5.2
    :target: https://fontawesome.com/icons?m=free
-.. |build-status| image:: https://img.shields.io/travis/bittner/django-bootstrap-static/master.svg?logo=travis
+.. |pipeline| image:: https://github.com/bittner/django-bootstrap-static/actions/workflows/pipeline.yml/badge.svg
    :alt: Build status
-   :target: https://travis-ci.org/bittner/django-bootstrap-static
+   :target: https://github.com/bittner/django-bootstrap-static/actions/workflows/pipeline.yml
 
 Install
 =======
@@ -75,7 +75,7 @@ to save a few kilobytes of bandwidth.
 
 More details on integration may be available from each of the two projects:
 
-- https://getbootstrap.com/docs/5.0/getting-started/introduction/
+- https://getbootstrap.com/docs/5.3/getting-started/introduction/
 - https://fontawesome.com/get-started (`Upgrading from Version 4 of Font Awesome`_)
 
 .. _Upgrading from Version 4 of Font Awesome:
@@ -91,18 +91,36 @@ Sources and Procedures
 ----------------------
 
 Bootstrap: (all files from dist package)
-    `Bootstrap website / Download`_ -> drop into ``bootstrap/static/bootstrap/``
+    `Bootstrap website / Download`_ ➜ drop into ``bootstrap/static/bootstrap/``
 jQuery: (compressed, uncompressed, map)
-    `jQuery website / Download`_ -> rename and mix into ``bootstrap/static/bootstrap/js/``
+    `jQuery website / Download`_ ➜ rename and mix into ``bootstrap/static/bootstrap/js/``
 
     Pick the latest version denoted as a dependency in ``bower.json`` (see `Dependencies`_).
 Font Awesome: (content of the ``on-server/`` folder only)
-    `Font Awesome website / Download Free`_ -> drop into ``fontawesome/static/fontawesome/``
+    `Font Awesome website / Download Free`_ ➜ drop into ``fontawesome/static/fontawesome/``
 
-.. _Bootstrap website / Download: https://getbootstrap.com/
-.. _jQuery website / Download: https://jquery.com/download/
-.. _Dependencies: https://getbootstrap.com/docs/5.0/getting-started/javascript/
-.. _Font Awesome website / Download Free: https://fontawesome.com/
+Tests
+-----
+
+Tests are great! And necessary. Please, add more. More is better!
+We use `Tox`_.
+
+.. code-block:: console
+
+    pip install tox
+
+Run all the linting and tests locally using Tox like this:
+
+.. code-block:: console
+
+    tox
+
+.. code-block:: console
+
+    tox list
+    tox -e package
+    tox -e py310,clean
+    tox -e format -- tests
 
 Releases
 ========
@@ -115,4 +133,9 @@ a new change within this package itself, e.g.
 ``django-bootstrap-static==3.3.1.1`` == Bootstrap ``3.3.1`` with an additional
 package change.
 
+.. _Bootstrap website / Download: https://getbootstrap.com/
+.. _jQuery website / Download: https://jquery.com/download/
+.. _Dependencies: https://getbootstrap.com/docs/5.0/getting-started/javascript/
+.. _Font Awesome website / Download Free: https://fontawesome.com/
+.. _Tox: https://tox.wiki/
 .. _semver: https://semver.org/

bootstrap/__init__.py

@@ -1,8 +1,5 @@
 """
-A collection of Bootstrap static files.
+A collection of Bootstrap static files. Font Awesome.
 """
-__author__ = 'Peter Bittner'
-__email__ = '[email protected]'
-__license__ = 'MIT'
-__url__ = 'https://github.com/bittner/django-bootstrap-static'
-__version__ = '5.3.3'
+
+__version__ = "5.3.3"

fontawesome/__init__.py

@@ -1,8 +1,5 @@
 """
-A collection of Bootstrap static files.
+A collection of Bootstrap static files. Font Awesome.
 """
-__author__ = 'Peter Bittner'
-__email__ = '[email protected]'
-__license__ = 'MIT'
-__url__ = 'https://github.com/bittner/django-bootstrap-static'
-__version__ = '6.5.2'
+
+__version__ = "6.5.2"

pyproject.toml

@@ -0,0 +1,61 @@
+[build-system]
+build-backend = "setuptools.build_meta"
+requires = ["setuptools>=64", "setuptools_scm>=8"]
+
+[project]
+name = "django-bootstrap-static"
+dynamic = ["version"]
+description = "A collection of Bootstrap static files."
+readme = "README.rst"
+license = {file = "LICENSE"}
+authors = [
+  {name = "Peter Bittner", email = "[email protected]"},
+]
+maintainers = [
+  {name = "Peter Bittner", email = "[email protected]"},
+]
+classifiers = [
+  "Development Status :: 5 - Production/Stable",
+  "Environment :: Web Environment",
+  "Intended Audience :: Developers",
+  "Natural Language :: English",
+  "Operating System :: OS Independent",
+  "Framework :: Django",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 2",
+  "Programming Language :: Python :: 3",
+  "Topic :: Internet :: WWW/HTTP :: Dynamic Content :: CGI Tools/Libraries",
+  "Topic :: Utilities",
+  "License :: OSI Approved :: MIT License",
+]
+keywords=[
+  "django",
+  "staticfiles",
+  "bootstrap",
+  "jquery",
+  "fontawesome",
+]
+
+[project.urls]
+source = "https://github.com/bittner/django-bootstrap-static"
+
+[tool.pytest.ini_options]
+addopts = "--color=yes --doctest-modules --verbose"
+
+[tool.ruff]
+extend-exclude = []
+extend-include = []
+
+[tool.ruff.lint]
+extend-select = ["ALL"]
+extend-ignore = ["ANN", "D", "INP001", "UP"]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*.py" = ["S101"]
+
+[tool.setuptools]
+include-package-data = true
+packages = ["bootstrap", "fontawesome"]
+
+[tool.setuptools_scm]
+local_scheme = "no-local-version"