README
generator-toptive-python
Toptive yeoman generator for python projects
Getting Started
generator-toptive-python
is a yeoman-generator for python projects using setuptools. The generator creates a boilerplate code that support:
- a standard
setup.py
,setup.cfg
,MANIFEST.in
, - project automation using
tox
, - static code analysis and reports using
pylint
andflake8
, - unit test cases using
pytest
, - system test cases using
robotframework
, - documentation with
sphinx
, .bumpversion
script,.gitignore
,.gitattributes
and.travis.yml
,- template for github issues and report bugs,
- a docker image
What's Yeoman?
Yeoman is a generic scaffolding system allowing the creation of any kind of app. It allows for rapidly getting started on new projects and streamlines the maintenance of existing projects.
Installation
First, install Yeoman and generator-toptive-python using npm (we assume you have pre-installed node.js).
npm install -g yo
npm install -g generator-toptive-python
Then generate your new project:
yo toptive-python
Getting To Know Yeoman
- Yeoman has a heart of gold.
- Yeoman is a person with feelings and opinions, but is very easy to work with.
- Yeoman can be too opinionated at times but is easily convinced not to be.
- Feel free to learn more about Yeoman.
License
MIT © Franco Riberi
Credits
This package was generated using Yeoman project and it was inspired in Cookiecutter project.