Extends phx-filters, adding filters for interpreting ISO codes.
Project description
ISO Filters
Adds filters for interpreting standard codes and identifiers, including:
ISO 3166-1 alpha-2 and alpha-3 country codes.
ISO 4217 currency codes.
IETF Language Tags (aka BCP 47).
Requirements
ISO Filters is known to be compatible with the following Python versions:
3.12
3.11
3.10
Installation
This package is an extension for the Filters library, so you can install it as an extra to phx-filters:
pip install phx-filters[iso]
If desired, you can install this package separately. This allows you to control the package version separately from phx-filters:
pip install phx-filters-iso
Running Unit Tests
Install the package with the test-runner extra to set up the necessary dependencies, and then you can run the tests with the tox command:
pip install -e .[test-runner] tox -p
To run tests in the current virtualenv:
python -m unittest
Documentation
Documentation is available on ReadTheDocs.
Source files for this project’s documentation can be found in the phx-filters repo.
Releases
Steps to build releases are based on Packaging Python Projects Tutorial
1. Build the Project
Install extra dependencies (you only have to do this once):
pip install -e '.[build-system]'
Delete artefacts from previous builds, if applicable:
rm dist/*
Run the build:
python -m build
The build artefacts will be located in the dist directory at the top level of the project.
2. Upload to PyPI
Create a PyPI API token (you only have to do this once).
Increment the version number in pyproject.toml.
Check that the build artefacts are valid, and fix any errors that it finds:
python -m twine check dist/*
Upload build artefacts to PyPI:
python -m twine upload dist/*
3. Create GitHub Release
Create a tag and push to GitHub:
git tag <version> git push
<version> must match the updated version number in pyproject.toml.
Go to the Releases page for the repo.
Click Draft a new release.
Select the tag that you created in step 1.
Specify the title of the release (e.g., ISO Filters v1.2.3).
Write a description for the release. Make sure to include: - Credit for code contributed by community members. - Significant functionality that was added/changed/removed. - Any backwards-incompatible changes and/or migration instructions. - SHA256 hashes of the build artefacts.
GPG-sign the description for the release (ASCII-armoured).
Attach the build artefacts to the release.
Click Publish release.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for phx_filters_iso-3.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dc4d022901d7d788499b217d2a65e8b01faedfb5bd6988f053ca8f1e312e8d67 |
|
MD5 | 2acb6b5fca0a3b015ec9edebb1fca39e |
|
BLAKE2b-256 | 73781d0f31f537dbe68c1f6ce0970376903c5173f2ea7dc5fcfc3df350b7ea2e |