Metadata-Version: 1.1
Name: lz
Version: 0.0.0
Summary: Python project template.
Home-page: https://github.com/lycantropos/lz/
Author: Azat Ibrakov
Author-email: azatibrakov@gmail.com
License: UNKNOWN
Download-URL: https://github.com/lycantropos/lz/archive/master.zip
Description: lz
        ===========
        
        |travis| |codecov| |license| |pypi|
        
        In what follows ``python3`` is an alias for ``python3.5`` or any later
        version (``python3.6`` and so on).
        
        Installation
        ------------
        
        Install the latest ``pip`` & ``setuptools`` packages versions
        
        .. code:: bash
        
            python3 -m pip install --upgrade pip setuptools
        
        Release
        ~~~~~~~
        
        Download and install the latest stable version from ``PyPI`` repository
        
        .. code:: bash
        
            python3 -m pip install --upgrade lz
        
        Developer
        ~~~~~~~~~
        
        Download and install the latest version from ``GitHub`` repository
        
        .. code:: bash
        
            git clone https://github.com/lycantropos/lz.git
            cd lz
            python3 setup.py install
        
        Bumping version
        ---------------
        
        Install `bumpversion`_.
        
        Choose which version number category to bump following `semver
        specification`_.
        
        Test bumping version
        
        .. code:: bash
        
            bumpversion --dry-run --verbose $VERSION
        
        where ``$VERSION`` is the target version number category name, possible
        values are ``patch``/``minor``/``major``.
        
        Bump version
        
        .. code:: bash
        
            bumpversion --verbose $VERSION
        
        **Note**: to avoid inconsistency between branches and pull requests,
        bumping version should be merged into ``master`` branch as separate pull
        request.
        
        Running tests
        -------------
        
        Plain
        
        .. code:: bash
        
            python3 setup.py test
        
        Inside ``Docker`` container
        
        .. code:: bash
        
            docker-compose up
        
        Inside ``Docker`` container with remote debugger
        
        .. code:: bash
        
            ./set-dockerhost.sh docker-compose up
        
        Bash script (e.g. can be used in ``Git`` hooks)
        
        .. code:: bash
        
            ./run-tests.sh
        
        .. _bumpversion: https://github.com/peritus/bumpversion#installation
        .. _semver specification: http://semver.org/
        
        .. |travis| image:: https://travis-ci.org/lycantropos/lz.svg?branch=master
           :target: https://travis-ci.org/lycantropos/lz
        .. |codecov| image:: https://codecov.io/gh/lycantropos/lz/branch/master/graph/badge.svg
           :target: https://codecov.io/gh/lycantropos/lz
        .. |license| image:: https://img.shields.io/github/license/lycantropos/lz.svg
           :target: https://github.com/lycantropos/lz/blob/master/LICENSE
        .. |pypi| image:: https://badge.fury.io/py/lz.svg
           :target: https://badge.fury.io/py/lz
        
Platform: UNKNOWN
