Metadata-Version: 2.1
Name: pypans
Version: 0.0.13
Summary: Serves command-line utility that creates python projects from certain based template.
Home-page: https://github.com/vyahello/pypans
Author: Volodymyr Yahello
Author-email: vyahello@gmail.com
License: UNKNOWN
Description: ![Screenshot](icon.png)
        
        [![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)](https://www.python.org/)
        [![Build Status](https://travis-ci.org/upymake/pypan.svg?branch=master)](https://travis-ci.org/upymake/pypan)
        [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
        [![Checked with pylint](https://img.shields.io/badge/pylint-checked-blue)](https://www.pylint.org)
        [![Checked with flake8](https://img.shields.io/badge/flake8-checked-blue)](http://flake8.pycqa.org/)
        [![Checked with pydocstyle](https://img.shields.io/badge/pydocstyle-checked-yellowgreen)](http://www.pydocstyle.org/)
        [![Checked with interrogate](https://img.shields.io/badge/interrogate-checked-yellowgreen)](https://interrogate.readthedocs.io/en/latest/)
        [![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
        [![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE.md)
        [![EO principles respected here](https://www.elegantobjects.org/badge.svg)](https://www.elegantobjects.org)
        [![CodeFactor](https://www.codefactor.io/repository/github/upymake/pypan/badge)](https://www.codefactor.io/repository/github/upymake/pypan)
        [![Downloads](https://pepy.tech/badge/pypans)](https://pepy.tech/project/pypans)
        [![PyPI version shields.io](https://img.shields.io/pypi/v/pypans.svg)](https://pypi.python.org/pypi/pypans/)
        [![PyPI pyversions](https://img.shields.io/pypi/pyversions/pypans.svg)](https://pypi.python.org/pypi/pypans/)
        
        # Pypan
        
        > A command-line utility that creates fresh **python** project from base template.
        
        ## Tools
        
        - python 3.6, 3.7, 3.8
        - [travis](https://travis-ci.org/) CI
        - code analysis
          - [pytest](https://pypi.org/project/pytest/)
          - [black](https://black.readthedocs.io/en/stable/)
          - [mypy](http://mypy.readthedocs.io/en/latest)
          - [pylint](https://www.pylint.org/)
          - [flake8](http://flake8.pycqa.org/en/latest/)
          - [pydocstyle](https://github.com/PyCQA/pydocstyle)
        
        ## Usage
        
        ### Quick start
        
        ```bash
        pip install pypans
        ✨ 🍰 ✨
        ```
        
        After please run **pypan** tool from your shell:
        ```bash
        pypan
        ```
        
        ### Source code
        
        ```bash
        git clone git@github.com:vyahello/pypans.git
        pip install -e .
        pypan
        ```
        
        Or using direct release:
        ```bash
        pip install git+https://github.com/vyahello/pypans@0.0.1
        pypan
        ```
        
        ### Local debug
        
        ```bash
        git clone git@github.com:vyahello/pypans.git
        python -m pypans
        ```
        **[⬆ back to top](#pypan)**
        
        ## Development notes
        
        ### Testing
        
        Generally, `pytest` tool is used to organize testing procedure.
        
        Please follow next command to run unittests:
        ```bash
        pytest
        ```
        
        ### CI
        
        Project has Travis CI integration using [.travis.yml](.travis.yml) file thus code analysis (`black`, `pylint`, `flake8`, `mypy`, `pydocstyle` and `interrogate`) and unittests (`pytest`) will be run automatically after every made change to the repository.
        
        To be able to run code analysis, please execute command below:
        ```bash
        ./analyse-source-code.sh
        ```
        ### Release notes
        
        Please check [changelog](CHANGELOG.md) file to get more details about actual versions and it's release notes.
        
        ### Meta
        
        Author – _Volodymyr Yahello_. Please check [authors](AUTHORS.md) file for more details.
        
        Distributed under the `MIT` license. See [license](LICENSE.md) for more information.
        
        You can reach out me at:
        * [vyahello@gmail.com](vyahello@gmail.com)
        * [https://github.com/vyahello](https://github.com/vyahello)
        * [https://www.linkedin.com/in/volodymyr-yahello-821746127](https://www.linkedin.com/in/volodymyr-yahello-821746127)
        
        ### Contributing
        1. clone the repository
        2. configure Git for the first time after cloning with your `name` and `email`
        3. `pip install -r requirements.txt` to install all project dependencies
        4. `pip install -r requirements-dev.txt` to install all development project dependencies
        
        **[⬆ back to top](#pypan)**
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
