Skip to main content

Vertex project tools to assist with packaging.

Project description

A collection of a few common tools which are useful for Python packaging and CI purposes.

These tools can be invoked as Python modules from the Python command line (python -m <module path>). Available tools include the following:

vtx_common.tools.github_release

This can be used to automatically push a Release up to github using a changelog file.

vtx_common.tools.pep8_staged_files

Runs autopep8 against the repository. Must be run from the root of the repository. Can use the following Bash alias to make this easier to invoke:

alias pep8staged='python -m vtx_common.tools.pep8_staged_files'
vtx_common.tools.pre_commit

This is used as a Git pre-commit hook. This can be easily installed via the following command:

echo "python -m vtx_common.tools.pre_commit" > .git/hooks/pre-commit && chmod +x .git/hooks/pre-commit

This will run pycodestyle against Python files to be committed. It assumes that there is a setup.cfg file in the root directory of the repo.

This package also installs bump2version, pytest, pytest-cov and pytest-xdist packages.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vtx-common-0.1.3.tar.gz (5.3 kB view hashes)

Uploaded Source

Built Distribution

vtx_common-0.1.3-py37-none-any.whl (11.1 kB view hashes)

Uploaded Python 3.7

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page