Metadata-Version: 2.1
Name: vtx-common
Version: 0.1.6
Summary: Vertex project tools to assist with packaging.
Home-page: https://github.com/vertexproject/common-tools
Author: The Vertex Project LLC
Author-email: epiphyte+tools@vertex.link
License: Apache License 2.0
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Topic :: System :: Clustering
Classifier: Topic :: System :: Distributed Computing
Classifier: Topic :: System :: Software Distribution
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/x-rst
Requires-Dist: PyGithub (==1.53)
Requires-Dist: pytest (<6.0.0,>=5.0.0)
Requires-Dist: autopep8 (<2.0.0,>=1.5.3)
Requires-Dist: pytest-cov (<3.0.0,>=2.9.0)
Requires-Dist: pycodestyle (<3.0.0,>=2.6.0)
Requires-Dist: bump2version (<1.1.0,>=1.0.0)
Requires-Dist: pytest-xdist (<2.0.0,>=1.32.0)

===================
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.

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

