cjwmodule 1.3.0

Utilities to help build Workbench modules

Utilities for CJWorkbench modules.

Workbench modules may optionally depend on the latest version of this Python package for its handy utilities:

• cjwmodule.http: HTTP helpers, including the handy httpfile format.
• cjwmodule.i18n: A trans() function for producing translatable text.
• cjwmodule.util.colnames: Functions to help build a valid table's column names.

Developing

1. Write a failing unit test in tests/
2. Make it pass by editing code in cjwmodule/
3. black cjwmodule tests && isort --recursive cjwmodule tests
4. Submit a pull request

Be very, very, very careful to preserve a consistent API. Workbench will upgrade this dependency without module authors' explicit consent. Add new features; fix bugs. Never change functionality.

I18n

Strings in cjwmodule can be marked for translation using cjwmodule.i18n._trans_cjwmodule. Each translation message must have a (unique) ID. ICU is supported for the content. For example,

from cjwmodule.i18n import _trans_cjwmodule

err = "Error 404"

_trans_cjwmodule(
    "greatapi.exception.message",
    "Something is wrong: {error}",
    {"error": err}
)

Workbench is wired to accept the return value of _trans_cjwmodule wherever an error/warning or quick fix is expected.

Calls to _trans_cjwmodule can (and must) be automatically parsed to create cjwmodule's po message files. This is accomplished by

python maintenance/i18n.py extract

For backwards compatibility, messages in cjwmodule's po files are never deleted!

Publishing

1. Write a new __version__ to cjwmodule/__init__.py. Adhere to semver. (As changes must be backwards-compatible, the version will always start with 1 and look like 1.x.y.)
2. Prepend notes to CHANGELOG.md about the new version
3. git commit
4. git tag v1.x.y
5. git push --tags && git push
6. Wait for Travis to push our changes to PyPI