diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index fb466e4..514bcb7 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -3,7 +3,7 @@ repos: - repo: https://github.com/astral-sh/ruff-pre-commit - rev: v0.6.9 + rev: v0.7.4 hooks: # Run the Ruff linter. - id: ruff @@ -12,15 +12,15 @@ repos: - id: ruff-format - repo: https://github.com/adamchainz/blacken-docs - rev: 1.19.0 + rev: 1.19.1 hooks: - id: blacken-docs additional_dependencies: - - black==24.4.2 + - black==24.10.0 files: '(?:README\.md|docs\/.*\.(?:md|rst))' - repo: https://github.com/asottile/pyupgrade - rev: v3.18.0 + rev: v3.19.0 hooks: - id: pyupgrade args: [ --py38-plus ] @@ -34,7 +34,7 @@ repos: stages: [ pre-push ] - repo: https://github.com/adamchainz/djade-pre-commit - rev: 1.3.0 + rev: 1.3.2 hooks: - id: djade args: [--target-version, "4.2"] diff --git a/CHANGES.md b/CHANGES.md index dfe97c7..4f9743b 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,5 +1,10 @@ # Changelog +**24.11.3 (2024-11-19)** +* Fixed a bug with switched `package_name` and `module_name` variables in templates +* Updated linters +* Improved some readme texts + **24.11.2 (2024-11-15)** * Updated Ubuntu images to latest 24.04 from 22.04 diff --git a/README.md b/README.md index 5feb4fe..fdbe5f2 100644 --- a/README.md +++ b/README.md @@ -133,13 +133,13 @@ To install the packages, run: - Create pull request / merge to master -- This project uses the flit package to publish to PyPI. Thus publishing should be as easy as running: +- This project uses the flit package to publish to PyPI. Thus, publishing should be as easy as running: ``` flit publish ``` - To publish to TestPyPI use the following ensure that you have set up your .pypirc as + To publish to TestPyPI use the following to ensure that you have set up your .pypirc as shown [here](https://flit.readthedocs.io/en/latest/upload.html#using-pypirc) and use the following command: ``` diff --git a/ambient_package_update/__init__.py b/ambient_package_update/__init__.py index 855dbc7..8876182 100644 --- a/ambient_package_update/__init__.py +++ b/ambient_package_update/__init__.py @@ -1,3 +1,3 @@ """Ambient package update tool for clean and swift maintenance""" -__version__ = "24.11.2" +__version__ = "24.11.3" diff --git a/ambient_package_update/templates/.pre-commit-config.yaml.tpl b/ambient_package_update/templates/.pre-commit-config.yaml.tpl index e376e15..1eeefe3 100644 --- a/ambient_package_update/templates/.pre-commit-config.yaml.tpl +++ b/ambient_package_update/templates/.pre-commit-config.yaml.tpl @@ -3,7 +3,7 @@ repos: - repo: https://github.com/astral-sh/ruff-pre-commit - rev: v0.6.9 + rev: v0.7.4 hooks: # Run the Ruff linter. - id: ruff @@ -12,15 +12,15 @@ repos: - id: ruff-format - repo: https://github.com/adamchainz/blacken-docs - rev: 1.19.0 + rev: 1.19.1 hooks: - id: blacken-docs additional_dependencies: - - black==24.4.2 + - black==24.10.0 files: '(?:README\.md|docs\/.*\.(?:md|rst))' - repo: https://github.com/asottile/pyupgrade - rev: v3.18.0 + rev: v3.19.0 hooks: - id: pyupgrade args: [ --py{{ supported_python_versions.0|replace(".", "") }}-plus ] @@ -34,7 +34,7 @@ repos: stages: [ pre-push ] - repo: https://github.com/adamchainz/djade-pre-commit - rev: 1.3.0 + rev: 1.3.2 hooks: - id: djade args: [--target-version, "4.2"] diff --git a/ambient_package_update/templates/pyproject.toml.tpl b/ambient_package_update/templates/pyproject.toml.tpl index 9a4d4f4..38d135d 100644 --- a/ambient_package_update/templates/pyproject.toml.tpl +++ b/ambient_package_update/templates/pyproject.toml.tpl @@ -178,7 +178,7 @@ python_files = [ branch = true parallel = true source = [ - "{{ package_name }}", + "{{ module_name }}", "tests", ] omit = [ @@ -204,6 +204,6 @@ exclude_also = [ [tool.coverage.path] source = [ - "{{ package_name }}", + "{{ module_name }}", ".tox/**/site-packages", ] diff --git a/ambient_package_update/templates/snippets/contribute.tpl b/ambient_package_update/templates/snippets/contribute.tpl index c725c02..aab387d 100644 --- a/ambient_package_update/templates/snippets/contribute.tpl +++ b/ambient_package_update/templates/snippets/contribute.tpl @@ -68,11 +68,11 @@ How to create translation file: * Navigate to `{{ package_name|replace("_", "-") }}` * `python manage.py makemessages -l de` -* Have a look at the new/changed files within `{{ package_name }}/locale` +* Have a look at the new/changed files within `{{ module_name }}/locale` How to compile translation files: * Navigate to `{{ package_name|replace("_", "-") }}` * `python manage.py compilemessages` -* Have a look at the new/changed files within `{{ package_name }}/locale` +* Have a look at the new/changed files within `{{ module_name }}/locale` {% endif %} diff --git a/ambient_package_update/templates/snippets/maintenance.tpl b/ambient_package_update/templates/snippets/maintenance.tpl index 8d0ad78..9e14399 100644 --- a/ambient_package_update/templates/snippets/maintenance.tpl +++ b/ambient_package_update/templates/snippets/maintenance.tpl @@ -1,8 +1,8 @@ ### Maintenance Please note that this package supports the [ambient-package-update](https://pypi.org/project/ambient-package-update/). -So you don't have to worry about the maintenance of this package. All important configuration and setup files are -being rendered by this updater. It works similar to well-known updaters like `pyupgrade` or `django-upgrade`. +So you don't have to worry about the maintenance of this package. This updater is rendering all important +configuration and setup files. It works similar to well-known updaters like `pyupgrade` or `django-upgrade`. To run an update, refer to the [documentation page](https://pypi.org/project/ambient-package-update/) of the "ambient-package-update". diff --git a/ambient_package_update/templates/snippets/publish.tpl b/ambient_package_update/templates/snippets/publish.tpl index bb2ab9a..91d35b9 100644 --- a/ambient_package_update/templates/snippets/publish.tpl +++ b/ambient_package_update/templates/snippets/publish.tpl @@ -14,12 +14,12 @@ - Create pull request / merge to {{ main_branch }} -- This project uses the flit package to publish to PyPI. Thus publishing should be as easy as running: +- This project uses the flit package to publish to PyPI. Thus, publishing should be as easy as running: ``` flit publish ``` - To publish to TestPyPI use the following ensure that you have set up your .pypirc as + To publish to TestPyPI use the following to ensure that you have set up your .pypirc as shown [here](https://flit.readthedocs.io/en/latest/upload.html#using-pypirc) and use the following command: ```