Flask-Phrase
Flask-Phrase is the official library for integrating Phrase Strings In-Context Editor with Flask
📜 Documentation
Prerequisites
To use Flask-Phrase with your application you have to:
- Sign up for a Phrase account: https://app.phrase.com/signup
- Use the Flask framework for Python
Demo
You can find a demo project in the demo folder, just run follow the README.md in that folder
Installation
NOTE: You can not use the old version of the ICE with integration versions of >2.0.0, you have to instead use 1.x.x versions as before
via pip
pip install Flask-Phrase
Configure
Add the following to your Flask app configuration (app.config or config.py file)
PHRASEAPP_ENABLED = True
PHRASEAPP_PREFIX = '{{__'
PHRASEAPP_SUFFIX = '__}}'
Your app code should look something like this:
from flask import Flask, [...]
from flask_babel import Babel
from flask_phrase import Phrase, gettext, ngettext
app = Flask(__name__)
babel = Babel(app)
phrase = Phrase(app)
Last step: add the Phrase JavaScript snippet to your base layout file with the following tag. This should go inside the section of your template file:
<script>
window.PHRASEAPP_CONFIG = {
projectId: "YOUR-PROJECT-ID",
accountId: "YOUR-ACCOUNT-ID",
datacenter: "eu",
origin: "Flask-Phrase"
};
(function() {
var phrasejs = document.createElement('script');
phrasejs.type = 'module';
phrasejs.async = true;
phrasejs.src = 'https://d2bgdldl6xit7z.cloudfront.net/latest/ice/index.js'
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(phrasejs, s);
})();
</script>
You can find your Project-ID and Account-ID in the Phrase Translation Center.
Old version of the ICE is not available since version 2.0.0. If you still would rather use the old version, please go back to 1.x.x versions.
Using the US Datacenter with ICE
In addition to projectId and accountId in the config, also add the US specific datacenter setting to enable working through the US endpoint.
window.PHRASEAPP_CONFIG = {
projectId: "YOUR-PROJECT-ID",
accountId: "YOUR-ACCOUNT-ID",
datacenter: "us",
origin: "Flask-Phrase"
};
How does it work
Set the PHRASEAPP_ENABLED to True/False to enable or disable In-Context-Editing. When set to False, it will fall back to standard Flask-Babel's gettext functions. Disable Phrase for production environments at any time!
When PHRASEAPP_ENABLED = True this package modifies the returning values from translation functions to present a format which the ICE can read.
Flask-Phrase provides In-Context translating facilities to your Flask app by hooking into flask-babel's gettext function. It exposes the underlying key names to the JavaScript editor that is provided by Phrase.
Test
Run unit tests:
python manage.py test
✅ Commits & Pull Requests
We welcome anyone who wants to contribute to our codebase, so if you notice something, feel free to open a Pull Request! However, we ask that you please use the Conventional Commits specification for your commit messages and titles when opening a Pull Request.
Example: chore: Update README
❓ Issues, Questions, Support
Please use GitHub issues to share your problem, and we will do our best to answer any questions or to support you in finding a solution.
📚 Resources
- Step-by-Step Guide on Flask-Babel and Flask-Phrase
- Flask-Phrase Demo Application.
- Localization Guides and Software Translation Best Practices
- Contact Phrase Team
📝 Changelog
Detailed changes for each release are documented in the changelog.
Metadata
Release files for Flask-Phrase 2.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| Flask-Phrase-2.0.1.tar.gz | 4.5 kB | Without provenance | Details for Flask-Phrase-2.0.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| Flask_Phrase-2.0.1-py3-none-any.whl | Python 3 | none | any | Details for Flask_Phrase-2.0.1-py3-none-any.whl |
Total release size: 9.4 kB
Release files / Flask-Phrase-2.0.1.tar.gz
| Download URL | Flask-Phrase-2.0.1.tar.gz |
|---|---|
| Size | 4.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
423ad12acf29ab07766517282c8bb753019d9931ee1cca0a5b6ee23c1ef7fb20
|
|
BLAKE2b-256 checksum How to use checksums |
d1aec824331d60fc549045cd9a8e52a2a7c25c06fe82a0cc0a96a5d70d226eea
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.0
|
Release files / Flask_Phrase-2.0.1-py3-none-any.whl
| Download URL | Flask_Phrase-2.0.1-py3-none-any.whl |
|---|---|
| Size | 4.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
17c128739a02d2a02bb6db62922ab129d5bdefc9c931aaf8de9eba5e74bf7fdf
|
|
BLAKE2b-256 checksum How to use checksums |
159f4362692fb81828e2e938994adf3d471bfbd29639b310b68e5da7370bdcf9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.0
|
Security for Flask-Phrase 2.0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.