Metadata-Version: 1.1
Name: peltak
Version: 0.15
Summary: Set of CLI commands to help manage a project
Home-page: http://github.com/novopl/peltak
Author: Mateusz 'novo' Klos
Author-email: novopl@gmail.com
License: MIT
Description: 
        ######
        peltak
        ######
        
        .. readme_inclusion_marker
        
        **peltak** is a command line tool to automate a lot of project related tasks.
        The tool should only wrap up existing project tools and not try to replace them.
        Also when implementing new commands lean towards just calling external tools
        rather than interfacing through the API. This way the commands implementation
        should resemble shell scripts in their structure and also serve as a reference
        on how to call the respective 3rd party tool without the use of **peltak**.
        Docker commands are a good example here as docker has a great python support
        but reading through the command implementation you know exactly what to do to
        do it manually and you probably don't even have to know python.
        
        **WARNING: Pre release state:** The project is mainly lacking good documentation
        for all commands. There are a few that are well documented from a user
        standpoint but not enough examples to fully understand all commands without
        looking at the source code. The testing could be improved as well as now it's
        mostly manually tested by being used in almost all my private projects and all
        of their CIs.
        
        .. note::
            The CircleCI builds can be found
            `here <https://circleci.com/gh/novopl/peltak>`_
        
        Installation
        ============
        
        .. code-block:: shell
        
            $ pip install peltak
        
        
        Contributing
        ============
        
        Setting up development repo
        ---------------------------
        
        .. code-block:: shell
        
            $ git clone git@github.com:novopl/peltak.git
            $ cd peltak
            $ virtualenv env
            $ source ./env/bin/activate
            $ pip install -r requirements.txt -r ops/devrequirements.txt
            $ peltak git add-hooks
        
        
        Running tests
        .............
        
        **Config**: The types of tests are defined in ``pelconf.py`` and the
        pytest configuration is defined in ``ops/tools/pytest.ini``.
        
        .. code-block:: shell
        
            $ peltak test
        
        Linting
        .......
        
        **Config**: The list of locations to lint is defined in ``pelconf.py`` and the
        linters configuration is defined in ``ops/tools/{pylint,pep8}.ini``.
        
        .. code-block:: shell
        
            $ peltak lint
        
        Generating docs
        ...............
        
        **Config**: The list of documented files and general configuration is in
        ``pelconf.py`` and the Sphinx configuration is defined in ``docs/conf.py``.
        
        .. code-block:: shell
        
            $ peltak docs
        
Keywords: fabric ops devops
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Topic :: Utilities
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: License :: OSI Approved :: MIT License
