ID Translation#

Turn meaningless IDs into human-readable labels.

Getting started#

The fastest way to get started with id-translation is the 🍪 id-translation-project Cookiecutter template. It is designed to allow power users to quickly specify shared configurations that “just work” for other users; see the example below.

# Generated by: cookiecutter https://github.com/rsundqvist/id-translation-project.git
from big_corporation_inc.id_translation import translate
print(
  "The first employee at Big Corporation Inc. was:",
  translate(1, names="employee_id"),
)

The template generates an installable {your-namespace}.id_translation module, with functions such as the one used above. Check out the demo project (and its 📚 generated documentation) to get a preview of what Your generated project might look like.

Hint

See the Translation primer for a high-level overview of the Translator plumbing.

Shortcuts#

Click an image below to get started, or use the top navigation bar.