Management commands¶
Примечание
Running management commands under different user than is running your webserver can cause wrong permissions on some files, please check Filesystem permissions for more details.
Django comes with management script (available as ./manage.py
in
sources or installed as weblate when Weblate is installed). It
provides various management commands and Weblate extends it with several
additional commands.
Invoking management commands¶
As mentioned before, invocation depends on how you have installed Weblate.
If you are using source code directly (either tarball or Git checkout), the
management script is ./manage.py
in Weblate sources. Execution can be
done as:
python ./manage.py list_versions
If you’ve istalled Weblate using PIP installer or by ./setup.py
script,
the weblate is installed to your path and you can use it to control
Weblate:
weblate list_versions
For Docker image, the script is installed same as above, you can execute it using docker exec:
docker exec <container> weblate list_versions
With docker-compose this is quite similar, you just have to use docker-compose run:
docker-compose run <container> weblate list_versions
add_suggestions¶
-
manage.py add_suggesstions <project> <component> <language> <file>
¶
Добавлено в версии 2.5.
Imports translation from the file as a suggestions to given translation. It skips translations which are same as existing ones, only different ones are added.
Email of author for the suggestions. This user has to exist prior importing (you can create one in the admin interface if needed).
Example:
./manage.py --author michal@cihar.com add_suggestions weblate master cs /tmp/suggestions-cs.po
auto_translate¶
-
manage.py auto_translate <project> <component> <language>
¶
Добавлено в версии 2.5.
Performs automatic translation based on other component translations.
-
--source
PROJECT/COMPONENT
¶ Specifies component to use as source for translation. If not specified all components in the project are used.
-
--user
USERNAME
¶ Specify username who will be author of the translations. Anonymous user is used if not specified.
-
--overwrite
¶
Whether to overwrite existing translations.
-
--inconsistent
¶
Whether to overwrite existing translations which are inconsistent (see Inconsistent).
-
--add
¶
Automatically add language if given translation does not exist.
Example:
./manage.py --user nijel --inconsistent --source phpmyadmin/master phpmyadmin 4-5 cs
См.также
changesite¶
-
manage.py changesite
¶
Добавлено в версии 2.4.
You can use this to change or display site name from command line without using admin interface.
-
--set-name
NAME
¶ Sets name for the site.
-
--get-name
¶
Prints currently configured site name.
См.также
checkgit¶
-
manage.py checkgit <project|project/component>
¶
Prints current state of backend git repository.
You can either define which project or component to update (eg.
weblate/master
) or use --all
to update all existing components.
commitgit¶
-
manage.py commitgit <project|project/component>
¶
Commits any possible pending changes to backend git repository.
You can either define which project or component to update (eg.
weblate/master
) or use --all
to update all existing components.
commit_pending¶
-
manage.py commit_pending <project|project/component>
¶
Commits pending changes older than given age.
You can either define which project or component to update (eg.
weblate/master
) or use --all
to update all existing components.
-
--age
HOURS
¶ Age in hours for committing. If not specified value configured in Component configuration is used.
This is most useful if executed periodically from cron or similar tool:
./manage.py commit_pending --all
cleanuptrans¶
-
manage.py cleanuptrans
¶
Cleanups orphaned checks and translation suggestions.
См.также
createadmin¶
-
manage.py createadmin
¶
Creates admin
account with random password unless it is specified.
-
--password
PASSWORD
¶ Provide password on the command line and skip generating random one.
-
--username
USERNAME
¶ Use given name instead of
admin
.
-
--email
USER@EXAMPLE.COM
¶ Specify admin email.
-
--name
¶
Specify admin name (visible).
-
--update
¶
Update existing user (you can use this to change password).
Изменено в версии 2.9: Added parameters --username
, --email
, --name
and --update
.
dumpuserdata¶
-
manage.py dumpuserdata <file.json>
¶
Dumps userdata to file for later use by importuserdata
This is useful when migrating of merging Weblate instances.
import_json¶
-
manage.py import_json <json-file>
¶
Добавлено в версии 2.7.
Batch import of components based on JSON data.
The imported JSON file structure pretty much corresponds to the component
object (see GET /api/components/(string:project)/(string:component)/
).
You always have to include fields name
and filemask
.
-
--project
PROJECT
¶ Specifies where the components will be imported.
-
--main-component
COMPONENT
¶ Use VCS repository from this component for all.
-
--ignore
¶
Skip already imported components.
-
--update
¶
Update already imported components.
Изменено в версии 2.9: Added parameters --ignore
and --update
to deal with already
imported components.
Example of JSON file:
[
{
"slug": "po",
"name": "Gettext PO",
"file_format": "po",
"filemask": "po/*.po"
},
{
"name": "Android",
"filemask": "android/values-*/strings.xml",
"template": "android/values/strings.xml",
"repo": "weblate://test/test"
}
]
См.также
import_project¶
-
manage.py import_project <project> <gitrepo> <branch> <filemask>
¶
Batch imports components into project based on file mask.
<project> names an existing project, into which the components should be imported.
The <gitrepo> defines URL of Git repository to use, and <branch> the git branch. To import additional translation components, from an existing Weblate component, use a weblate://<project>/<component> URL for the <gitrepo>.
The repository is searched for directories matching a double wildcard (**) in the <filemask>. Each of these is then added as a component, named after the matched directory. Existing components will be skipped.
-
--name-template
TEMPLATE
¶ Customise the component’s name, its parameter is a python formatting string, which will expect the match from <filemask>.
-
--base-file-template
TEMPLATE
¶ Customize base file for monolingual translations.
-
--file-format
FORMAT
¶ You can also specify file format to use (see Supported formats), the default is autodetection.
-
--language-regex
REGEX
¶ You can specify language filtering (see Component configuration) by this parameter. It has to be valid regular expression.
-
--main-component
¶
You can specify which component will be chosen as main - the one actually containing VCS repository.
-
--license
NAME
¶ Specify translation license.
-
--license-url
URL
¶ Specify translation license URL.
-
--vcs
NAME
¶ In case you need to specify version control system to use, you can do it here. The default version control is Git.
-
--component-regexp
REGEX
¶ You can override parsing of component name from matched files here. This is a regular expression which will be matched against file name (as matched by <filemask>) and has to contain named groups name and language. This can be also used for excluding files in case they do not match this expression. For example:
(?P<language>.*)/(?P<name>[^-]*)\.po
-
--no-skip-duplicates
¶
By default the import does skip already existing projects. This is to allow repeated importing of same repository. However if you want to force importing additional components even if name or slug matches existing one, you can do it by passing
--no-skip-duplicates
. This is generally useful for components with long names, which will get truncated on import and many of them will get same name or slug.
To give you some examples, let’s try importing two projects.
As first we import The Debian Handbook translations, where each language has separate folder with translations of each chapter:
./manage.py import_project \
debian-handbook \
git://anonscm.debian.org/debian-handbook/debian-handbook.git \
squeeze/master \
'*/**.po'
Another example can be Tanaguru tool, where we need to specify file format, base file template and has all components and translations located in single folder:
./manage.py import_project \
--file-format=properties \
--base-file-template=web-app/tgol-web-app/src/main/resources/i18n/%s-I18N.properties \
tanaguru \
https://github.com/Tanaguru/Tanaguru \
master \
web-app/tgol-web-app/src/main/resources/i18n/**-I18N_*.properties
Example of more complex parsing of filenames to get correct component and
language out of file name like
src/security/Numerous_security_holes_in_0.10.1.de.po
:
./manage.py import_project \
--component-regexp 'wiki/src/security/(?P<name>.*)\.([^.]*)\.po$' \
tails \
git://git.tails.boum.org/tails master \
'wiki/src/security/**.*.po'
Filtering only translations in chosen language:
./manage import_project \
--language-regex '^(cs|sk)$' \
weblate \
https://github.com/WeblateOrg/weblate.git \
'weblate/locale/*/LC_MESSAGES/**.po'
См.также
More detailed examples can be found in the Starting with internationalization chapter,
alternatively you might want to use import_json
.
importuserdata¶
-
manage.py importuserdata <file.json>
¶
Imports userdata from file created by dumpuserdata
importusers¶
-
manage.py importusers --check <file.json>
¶
Imports users from JSON dump of Django auth_users database.
-
--check
¶
With this option it will just check whether given file can be imported and report possible conflicts on usernames or emails.
You can dump users from existing Django installation using:
./manage.py dumpdata auth.User > users.json
list_ignored_checks¶
-
manage.py list_ignored_checks
¶
Lists most frequently ignored checks. This can be useful for tuning your setup, if users have to ignore too many of consistency checks.
list_translators¶
-
manage.py list_translators <project|project/component>
¶
Renders the list of translators by language for the given project:
[French]
Jean Dupont <jean.dupont@example.com>
[English]
John Doe <jd@exemple.com>
-
--language-code
¶
Use language code instead of language name in output.
You can either define which project or component to use (eg.
weblate/master
) or use --all
to list translators from all existing
components.
loadpo¶
-
manage.py loadpo <project|project/component>
¶
Reloads translations from disk (eg. in case you did some updates in VCS repository).
-
--force
¶
Force update even if the files should be up to date.
-
--lang
LANGUAGE
¶ Limit processing to single languaguage.
You can either define which project or component to update (eg.
weblate/master
) or use --all
to update all existing components.
lock_translation¶
-
manage.py lock_translation <project|project/component>
¶
Locks given component for translating. This is useful in case you want to do some maintenance on underlaying repository.
You can either define which project or component to update (eg.
weblate/master
) or use --all
to update all existing components.
См.также
pushgit¶
-
manage.py pushgit <project|project/component>
¶
Pushes committed changes to upstream VCS repository.
-
--force-commit
¶
Force committing any pending changes prior to push.
You can either define which project or component to update (eg.
weblate/master
) or use --all
to update all existing components.
rebuild_index¶
-
manage.py rebuild_index <project|project/component>
¶
Rebuilds index for fulltext search. This might be lengthy operation if you have huge set of translation units.
-
--clean
¶
Removes all words from database prior updating.
-
--optimize
¶
The index will not be processed again, only it’s content will be optimized (removing stale entries and merging possibly split index files).
См.также
update_index¶
-
manage.py update_index
¶
Updates index for fulltext search when OFFLOAD_INDEXING
is enabled.
It is recommended to run this frequently (eg. every 5 minutes) to have index uptodate.
unlock_translation¶
-
manage.py unlock_translation <project|project/component>
¶
Unnocks given component for translating. This is useful in case you want to do some maintenance on underlaying repository.
You can either define which project or component to update (eg.
weblate/master
) or use --all
to update all existing components.
См.также
setupgroups¶
-
manage.py setupgroups
¶
Configures default groups and optionally assigns all users to default group.
-
--move
¶
Assigns all users to the default group.
-
--no-privs-update
¶
Disables update of existing groups (only adds new ones).
См.также
setuplang¶
-
manage.py setuplang
¶
Setups list of languages (it has own list and all defined in translate-toolkit).
-
--no-update
¶
Disables update of existing languages (only adds new ones).