Metadata-Version: 2.1
Name: manati
Version: 0.0.3
Summary: A Python CLI for managing Python projects.
Home-page: https://github.com/maroba/manati
Author: maroba
Author-email: matthias.r.baer@googlemail.com
License: GPL v3
Description: 
        # manati
        
        A command line interface (CLI) for managing Python projects.
        
        ![https://de.vecteezy.com/gratis-vektor/natur](docs/images/manati.png) 
        
        [![PyPI version](https://badge.fury.io/py/manati.svg)](https://badge.fury.io/py/manati)
        [![Doc Status](https://readthedocs.org/projects/manati/badge/?version=latest)](https://manati.readthedocs.io/en/latest/index.html)
        
        
        
        
        ## Usage
        
        ### Creating a project
        
        ```
        manati create project -n myproject
        ```
        
        creates a complete Python project structure inside the current working directory:
        
        ```
        .
        ├── docs
        │   ├── Makefile
        │   ├── conf.py
        │   ├── index.rst
        │   ├── make.bat
        │   └── requirements.txt
        ├── myproject
        │   ├── __init__.py
        │   └── main.py
        ├── setup.py
        ├── .gitignore
        └── tests
            └── test_main.py
        ```
        
        including sample source,
        tests, documentation, `setup.py`, local `git` repository and a
        suitable `.gitignore` file.
        
        After creation, the project is already installed in development (editable) mode, so you can start coding right away.
        
        #### Running tests
        
        A smoke test as template for further tests is also created and you can run the tests as usual like so:
        
        ```
        python -m unittest discover tests
        ```
        
        #### Building the project documentation
        
        After creation of the project, a documentation folder using Sphinx has been prepared, and the first version has
        already been built. You can look at the documentation using your favorite brower by opening `./docs/_build/html/index.html`.
        
        If you want to update the documentation, rebuild by
        
        ```
        cd docs
        make clean
        make html
        ```
        
        
        ## Installation
        
        Just use `pip`:
        
        ```
        pip install --upgrade manati
        ```
        
        ## Documentation
        
        The full documentation can be found [here](https://manati.readthedocs.io/en/latest/).
        
        
        #### Credits
        
        Images by [Natur Vektoren von Vecteezy](https://de.vecteezy.com/gratis-vektor/natur).
        
Keywords: CLI
Platform: ALL
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.6
Description-Content-Type: text/markdown
