ID Translation
Convert IDs to human-readable labels.
What is it?
A package suite for translating integer IDs typically found in databases. Translation is highly configurable and tested for multiple different SQL dialects and schema naming paradigms. This is configurable using TOML, allowing power users to specify shared configurations that "just work" for other users; see the snippet below.
from id_translation import Translator
translator = Translator.load_persistent_instance("/mnt/companyInc/id-translation/config.toml")
print(
"The first employee at Company Inc was:",
translator.translate(1, names="employee_id"),
)
A function to create Translator instances that "just work".
Highlighted Features
- Support for
intandstringIDs or a collection thereof, with automatic name and ID extraction. - Translation of pandas types, including
pandas.Indextypes. - Intuitive Format strings, with support for optional elements.
- Powerful automated Name-to-source and Format placeholder mapping.
- Prebuilt fetchers for SQL and file-system sources.
- Configure using TOML, support for persistent instances stored on disk.
Installation
The package is published through the Python Package Index (PyPI). Source code is available on GitHub: https://github.com/rsundqvist/id-translation
pip install -U id-translation
This is the preferred method to install id-translation, as it will always install the
most recent stable release.
If you don't have pip installed, this Python installation guide can guide you through the process.
License
Documentation
Hosted on Read the Docs: https://id-translation.readthedocs.io
Contributing
All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome. To get started, see the Contributing Guide and Code of Conduct.
1 maintainer
Release files for id-translation 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| id_translation-0.2.0.tar.gz | 44.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| id_translation-0.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size:100.2 kB
Release files / id_translation-0.2.0.tar.gz
| Download URL | id_translation-0.2.0.tar.gz |
|---|---|
| Size | 44.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
19b83a629c1dea667446e75d543fa0c48b4926dd0be889e545de6d04584b024f
|
|
BLAKE2b-256 checksum How to use checksums |
d3be79734ff691393ce8c3cdcad200c30f4e600e22b87eef13b9d83f016caf9a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.9.15
|
Release files / id_translation-0.2.0-py3-none-any.whl
| Download URL | id_translation-0.2.0-py3-none-any.whl |
|---|---|
| Size | 55.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
402c51c56c3d3a3b4b29e5c11ceb9d55b9392074321091c8b110102d74a9b884
|
|
BLAKE2b-256 checksum How to use checksums |
c955f574be6091924fdac6364445fc93d3202ed82987248a5e08a67d7fa019f6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.9.15
|
