Skip to main content

Vertex Common Tools

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. Many values may automatically be resolved from environment variables. Some values may also come from setup.cfg files. The following config values are read from that location (under the section vtx_common:github_release):

release-name

Name to prefix the release as.

extra-lines

Additional lines appended to the changelog. This setting may only be set via setup.cfg.

remove-urls

Boolean to remove lines starting as RST URL links from changelog lines.

dry-run

Do a dry run. Still requires a tag to be parsable from a environment variable.

changelog

The changelog file to parse.

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.

vtx_common.tools.buildpkg

This will execute rstorm files for a given storm package file following Vertex conventions, in order to generate markdown documentation for the package that can be viewed in the Synapse UI. This requires having the Synapse python package available, as well as pandoc. Pandoc should be ve`rs`ion 2.14.0.1 or greater.

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

Metadata

Release files for vtx-common 0.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for vtx-common 0.2.1
File Size Uploaded Provenance Actions
vtx-common-0.2.1.tar.gz 20.4 kB Without provenance Details for vtx-common-0.2.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for vtx-common 0.2.1
File Interpreter ABI Platform Actions
vtx_common-0.2.1-py311-none-any.whl Python 3.11 none any Details for vtx_common-0.2.1-py311-none-any.whl

Total release size: 44.4 kB

Release files / vtx-common-0.2.1.tar.gz

Download URL vtx-common-0.2.1.tar.gz
Size 20.4 kB
Tags Source
SHA-256 checksum
How to use checksums
837f9e255f28540ef2f3e62127a5a35436613bbc7eb7c48a5b6dec3e7552fbfd
BLAKE2b-256 checksum
How to use checksums
4786bf2da47fedef324aa621bda691697dcfebed4a7cd12e58dd5cd897279512
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.13

Release files / vtx_common-0.2.1-py311-none-any.whl

Download URL vtx_common-0.2.1-py311-none-any.whl
Size 24.0 kB
Tags Python 3.11
SHA-256 checksum
How to use checksums
94fb57d9cb95a9494b8150664b699d673c08d326c9a4ba82d390974ca4287f82
BLAKE2b-256 checksum
How to use checksums
efee6d1853fbc7ae58772eba0c1143bc7a8d818efc22f51afbbe59e0e498bdcb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.13

Security for vtx-common 0.2.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.

Release history Release notifications | RSS feed

This release

0.2.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page