Metadata-Version: 2.1
Name: ve
Version: 0.0.1
Summary: ve application
Home-page: https://pypi.org/project/ve/
Author: sinoroc
Author-email: sinoroc.code+python@gmail.com
License: Apache-2.0
Project-URL: GitLab, https://gitlab.com/sinoroc/ve
Project-URL: GitHub, https://github.com/sinoroc/ve
Platform: UNKNOWN
Description-Content-Type: text/x-rst
Requires-Dist: importlib-metadata
Provides-Extra: package
Requires-Dist: twine ; extra == 'package'
Requires-Dist: wheel ; extra == 'package'
Requires-Dist: zapp ; extra == 'package'
Provides-Extra: test
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: pytest-pycodestyle ; extra == 'test'
Requires-Dist: pytest-pylint ; extra == 'test'

..


.. contents::

.. sectnum::


Repositories
============

Distributions
-------------

* https://pypi.org/project/ve/


Source code
-----------

* https://gitlab.com/sinoroc/ve
* https://github.com/sinoroc/ve


Usage
=====

.. code::

    $ ve -h
    usage: ve [-h] [--version] [directory]

    positional arguments:
      directory   create the virtual environment in this directory (default .venv)

    optional arguments:
      -h, --help  show this help message and exit
      --version   show program's version number and exit


Hacking
=======

This project makes extensive use of `tox`_, `pytest`_, and `GNU Make`_.


Development environment
-----------------------

Use following command to create a Python virtual environment with all
necessary dependencies::

    tox --recreate -e develop

This creates a Python virtual environment in the ``.tox/develop`` directory. It
can be activated with the following command::

    . .tox/develop/bin/activate


Run test suite
--------------

In a Python virtual environment run the following command::

    make review

Outside of a Python virtual environment run the following command::

    tox --recreate


Build and package
-----------------

In a Python virtual environment run the following command::

    make package

Outside of a Python virtual environment run the following command::

    tox --recreate -e package


.. Links

.. _`GNU Make`: https://www.gnu.org/software/make/
.. _`pytest`: https://pytest.org/
.. _`tox`: https://tox.readthedocs.io/


.. EOF


