Pypan

A command-line utility that creates a fresh python project interactively right within your shell.

The main goal of the tool is to build the project with strict static analysis templates.

Tools

Production

• python 3.6, 3.7, 3.8

Development

• travis
• pytest
• black
• mypy
• pylint
• flake8
• pydocstyle
• interrogate
• check-manifest

Usage

Quick start

pip install pypans
✨ 🍰 ✨

After please run pypan tool from your shell:

pypan

Please modify README.md file for your needs afterwards.

Source code

git clone git@github.com:vyahello/pypans.git
pip install -e .
pypan

Or using direct release:

pip install git+https://github.com/vyahello/pypans@0.0.1
pypan

Local debug

git clone git@github.com:vyahello/pypans.git
python -m pypans

⬆ back to top

Development notes

Testing

Generally, pytest tool is used to organize testing procedure.

Please follow next command to run unittests:

pytest

CI

Project has Travis CI integration using .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:

./analyse-source-code.sh

Release notes

Please check changelog file to get more details about actual versions and it's release notes.

Meta

Author – Volodymyr Yahello. Please check authors file for more details.

Distributed under the MIT license. See license for more information.

You can reach out me at:

• vyahello@gmail.com
• https://twitter.com/vyahello
• https://www.linkedin.com/in/volodymyr-yahello-821746127

Contributing

I would highly appreciate any contribution and support. If you are interested to add your ideas into project please follow next simple steps:

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
5. Create your feature branch (git checkout -b feature/fooBar)
6. Commit your changes (git commit -am 'Add some fooBar')
7. Push to the branch (git push origin feature/fooBar)
8. Create a new Pull Request

What's next

All recent activities and ideas are described at project issues page. If you have ideas you want to change/implement please do not hesitate and create an issue.

⬆ back to top