pygitrepo 0.0.25

Allow beginner to develop Python project like a Pro - Quickly initiate a python project from scratch.

---

Welcome to pygitrepo Documentation

pygitrepo is a tool that can initiate a professional-liked python project skeleton from scratch, JUST NEED TO ENTER THE LIBRARY NAME!

WITHOUT pygitrepo:

$ git init my_library # initiate your git repo
$ vim .gitignore # edit .gitignore file

$ virtualenv my_library_venv # create venv
$ source ./my_project_venv/bin/activate # activate venv
$ vim setup.py # edit setup.py file, DO YOU REALLY KNOW HOW TO WRITE setup.py FILE?
$ pip install . # install your library and dependencies
$ pip install pytest
$ mkdir tests # write some test
$ pip install sphinx
$ sphinx-quickstart # initiate doc
$ vim docs/source/conf.py # configure your doc settings

Now you finally read to start writing the real code. However, it could be more complicate on Windows.

After you finished your development, you want to test it before you publish:

$ vim .travis.yml # configure your continues-integration, or use .circleci
$ vim tox.ini # configure tox to test on Py2.7, 3.4, 3.5, ...
$ vim .coveragerc # configure code coverage test
$ pip install tox
$ pip install coverage

I guess it would take you at least AN HOUR to read the document for continues integration, code coverage test, and multiple python version test… Do you know how many pitfalls are in these?

But if WITH pygitrepo:

$ pip install pygitrepo
$ pygitrepo-init # call the command line tool, and enter your project name
(REQUIRED) Your Package Name (e.g. pip): pygitrepo
(REQUIRED) Your Github Username: Machu-GWU
more optional prompt, you can use the default ...

Done!

a new git repo directory my_library-project will be created. .gitignore, setup.py, requirements-dev/doc/test.txt, .travis.yml, .coveragerc, docs/source/conf.py, tests/some_test.py ..., etc, … All functions are ready to use, you don’t need to edit anything!

Create and Remove virtualenv:

$ make up # create
$ make clean # remove

Install your library and Run Test:

$ make test # unit test
$ make cov # code coverage test
$ make tox # multi python version test

Build Document with auto-generated API reference:

$ make build_doc # build your document site
$ make view_doc # open your doc in browser
$ make deploy_doc # deploy your doc website to s3

Want to publish to Python Package Index?, Let’s do:

$ make publish

Install

pygitrepo is released on PyPI, so all you need is:

$ pip install pygitrepo

To upgrade to latest version:

$ pip install --upgrade pygitrepo