Command line interface¶
clean¶
Usage: crl clean [--options] [other tasks here ...]
Docstring:
Clean workspace.
By default deletes 'dist' directory and removes '*.pyc'
and '$py.class' files.
Args:
create_dirs: Re-create 'dist' after removing it.
Options:
-c, --create-dirs
-r, --[no-]remove-dist
create_docs¶
Usage: crl create_docs [--options] [other tasks here ...]
Docstring:
Create both Robot Framework and Sphinx documentation.
If 'robotdocsconf.py' exists in root folders then Robot
Framework test libraries and resource files documentation
is generated and integrated with Sphinx documentation.
'robotdocsconf.py' is searched from robotdocs_root_folders
recursively.
Example 1 'robotdocsconf.py' for python library documentation:
module_name = "RunnerExecutor Libraries"
output_file = "RunnerExecutor.rst"
robotdocs = {
'RunnerExecutor.remoterunnerexecutor.RemoteRunnerExecutor': {
'args': ['None', 'None', 'False'],
'docformat': 'robot',
'synopsis': ('Command executor in the remote target shell.')},
'RunnerExecutor.remoterunnerexecutor.SftpTransfer': {
'args': ['False'],
'docformat': 'robot',
'synopsis': ('Command executor in the remote target shell.')}
Example 2 'robotdocsconf.py' for robot resource file documentation:
module_name = "Deployment Helpers"
output_file = "Framework_deployment.rst"
robotdocs = {
'resources/framework/deployment/_deployment_helper.robot': {
'docformat': 'robot'
}
}
Robotdocsconf.py's output_file will be the name of the generated
'sphinxdocs/.........rst' file. A good practice is to name it so that
library's identification is easy. If output_file is missing then
robotdocs.rst will be the file name. Robotdocsconf.py's module_name will
be written to rst file header. Header text will be: 'Robot Framework Test
Libraries' if the module name is missing.
Sphinx documentation is generated according to 'sphinxdocs/conf.py'.
Args:
robotdocs_root_folders: folders list with relative or
absolute path separated by ':',
robotdocsconf.py is searched from these root folders recursively
verbose: Display task execution in more detail.
Example:
crl create_docs -r library_root_folder1:library_root_folder2 -v
Options:
-r STRING, --robotdocs-root-folders=STRING
-v, --verbose
create_index¶
Usage: crl create_index [--options] [other tasks here ...]
Docstring:
Create an index with given bases
Args:
index: Name of the index to create
baseindex: URL of devpi PyPI index to be used as base index.
Format: http[s]://host:user/indexname.
additional_index: Other additional indices to use as base.
Format: 'user/index1,user/index2'
credentials_file: /full/path/to/credentials/file with plain text
content username:password. In case no
credentials_file given, the default devpi clientdir
authorization token is used.
verbose: Display task execution in more detail.
Options:
-a STRING, --additional-index=STRING
-b STRING, --baseindex=STRING
-c STRING, --credentials-file=STRING
-i STRING, --index=STRING
-v, --verbose
create_robotdocs¶
Usage: crl create_robotdocs [--options] [other tasks here ...]
Docstring:
Create only Robot Framework ReST documentation.
If 'robotdocsconf.py' exists in root folders then Robot
Framework test libraries and resource files documentation
is generated and integrated with Sphinx documentation.
'robotdocsconf.py' is searched from robotdocs_root_folders
recursively.
Example 1 'robotdocsconf.py' for python library documentation:
module_name = "RunnerExecutor Libraries"
output_file = "RunnerExecutor.rst"
robotdocs = {
'RunnerExecutor.remoterunnerexecutor.RemoteRunnerExecutor': {
'args': ['None', 'None', 'False'],
'docformat': 'robot',
'synopsis': ('Command executor in the remote target shell.')},
'RunnerExecutor.remoterunnerexecutor.SftpTransfer': {
'args': ['False'],
'docformat': 'robot',
'synopsis': ('Command executor in the remote target shell.')}
Example 2 'robotdocsconf.py' for robot resource file documentation:
module_name = "Deployment Helpers"
output_file = "Framework_deployment.rst"
robotdocs = {
'resources/framework/deployment/_deployment_helper.robot': {
'docformat': 'robot'
}
}
Robotdocsconf.py's output_file will be the name of the generated
'sphinxdocs/.........rst' file. A good practice is to name it so that
library's identification is easy. If output_file is missing then
robotdocs.rst will be the file name. Robotdocsconf.py's module_name will
be written to rst file header. Header text will be: 'Robot Framework Test
Libraries' if the module name is missing.
Sphinx documentation is generated according to 'sphinxdocs/conf.py'.
Args:
robotdocs_root_folders: folders list with relative or
absolute path separated by ':',
robotdocsconf.py is searched from these root folders recursively
verbose: Display task execution in more detail.
Example:
crl create_robotdocs -r library_root_folder1:library_root_folder2 -v
Options:
-r STRING, --robotdocs-root-folders=STRING
-v, --verbose
create_setup¶
Usage: crl create_setup [--options] [other tasks here ...]
Docstring:
Create initial setup.py into current directory from library name.
The module setup will define path to version file
by joining it with src/crl/libname/_version.py.
The new file is added and committed by default to git.
Args:
libname: Name of the library. If not given first directory under
src/crl is used as library name
add_to_git: If True, add the setup.py to git.
Options:
-a, --[no-]add-to-git
-l STRING, --libname=STRING
delete_index¶
Usage: crl delete_index [--options] [other tasks here ...]
Docstring:
Delete an index
Args:
index: URL of the devpi PyPI index to delete.
Format: http[s]://host:user/indexname
credentials_file: /full/path/to/credentials/file with plain text
content username:password. In case no
credentials_file given, the default devpi clientdir
authorization token is used.
verbose: Display task execution in more detail.
Options:
-c STRING, --credentials-file=STRING
-i STRING, --index=STRING
-v, --verbose
help¶
Usage: crl help [other tasks here ...]
Docstring:
Show help, basically an alias for --help.
This task can be removed once the fix to this issue is released:
https://github.com/pyinvoke/invoke/issues/180
Options:
none
publish¶
Usage: crl publish [--options] [other tasks here ...]
Docstring:
*DEPRECATED* Publish version from a given index to another index.
Args:
srcindex: URL of devpi PyPI index from where to find the new version.
Format http[s]://host:user/indexname.
destindex: URL(short format) of devpi PyPI index to publish to.
Format: user/indexname.
tag_if_needed: Tags using the package's version if not found tagged.
credentials_file: /full/path/to/credentials/file with plain text
content username:password. In case no
credentials_file given, the default devpi clientdir
authorization token is used.
tag_branch: Alternative git branch where the tag must be.
verbose: Display task execution in more detail.
Options:
-a STRING, --tag-branch=STRING
-c STRING, --credentials-file=STRING
-d STRING, --destindex=STRING
-s STRING, --srcindex=STRING
-t, --tag-if-needed
-v, --verbose
sdist¶
Usage: crl sdist [--options] [other tasks here ...]
Docstring:
Create source distribution.
Args:
deploy: Register and upload sdist to PyPI.
remove_dist: Control is 'dist' directory initially removed or not.
Options:
-d, --deploy
-r, --remove-dist
set_version¶
Usage: crl set_version [--options] [other tasks here ...]
Docstring:
Set version in ./src/crl/<libname>/_version.py`.
Version can have these values:
- Actual version number to use. See below for supported formats.
- String 'dev' to update version to latest development version
(e.g. 2.8 -> 2.8.1.dev, 2.8.1 -> 2.8.2.dev, 2.8a1 -> 2.8.dev) with
the current date added or updated.
- String 'keep' to keep using the previously set version.
Given version must be in one of these PEP-440 compatible formats:
- Stable version in 'X.Y' or 'X.Y.Z' format (e.g. 2.8, 2.8.6)
- Pre-releases with 'aN', 'bN' or 'rcN' postfix (e.g. 2.8a1, 2.8.6rc2)
- Development releases with '.devYYYYMMDD' postfix (e.g. 2.8.6.dev20141001)
or with '.dev' alone (e.g. 2.8.6.dev) in which case date is added
automatically.
Args:
version: Version to use. See above for supported values and formats.
push: Commit and push changes to the remote repository.
libname: Name of the directory under ./src/crl where version
file (_version.py) is located. By default the first
directory name is used.
pathtoversionfile: Alternative relative path to version file.
verbose: display task execution in more detail.
Options:
-a STRING, --pathtoversionfile=STRING
-e, --verbose
-l STRING, --libname=STRING
-p, --push
-v STRING, --version=STRING
tag_release¶
Usage: crl tag_release [--options] [other tasks here ...]
Docstring:
Tag specified release.
Updates version using `set_version`, creates tag, and pushes changes.
Args:
version: Version to use. See above for supported values and formats.
libname: Name of the directory under ./src/crl where version
file (_version.py) is located. By default the first
directory name is used.
push: Push updated version file and tag to the remote.
pathtoversionfile: Alternative relative path to version file.
verbose: Display task execution in more detail.
Options:
-a STRING, --pathtoversionfile=STRING
-e, --verbose
-l STRING, --libname=STRING
-p, --[no-]push
-v STRING, --version=STRING
tag_setup_version¶
Usage: crl tag_setup_version [--options] [other tasks here ...]
Docstring:
Tag specified release.
Creates tag of version in setup and pushes changes.
Args:
verbose: Display task execution in more detail.
Options:
-v, --verbose
test¶
Usage: crl test [--options] [other tasks here ...]
Docstring:
Uploads contents of current workspace to devpi and runs tox tests.
Args:
baseindex: URL of devpi PyPI index to be used as base index.
Format: http[s]://host:user/indexname.
testindex: Name of the index to be used for running tests.
If the given index doesn't exist, it is created.
If not specified, uses a temporary index.
credentials_file: /full/path/to/credentials/file with plain text
content username:password. In case no
credentials_file given, the default devpi clientdir
authorization token is used.
save_tests_to: Copy tests temporary directory to this new not yet
existing directory.
virtualenv: Create and run the task in a new temporary virtualenv.
pathtoversionfile: Alternative relative path to version file.
verbose: Display task execution in more detail.
Options:
-b STRING, --baseindex=STRING
-c STRING, --credentials-file=STRING
-e, --verbose
-p STRING, --pathtoversionfile=STRING
-s STRING, --save-tests-to=STRING
-t STRING, --testindex=STRING
-v, --[no-]virtualenv