pygitrepo 0.0.17

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

Welcome to pygitrepo Documentation

pygitrepo can quickly initiate a python project from scratch, and you get these development tools ready to use and configured:

• virtual environment management, up, clean, switch.

• continues integration for unit test and code coverage on your local machine and also cloud.

• document site management, write, build, view and deploy.

• publish your package to PyPI, make it installable everywhere.

Quick Links

• 
• 
• 
• 
• 
• 

Features

If you initiate your project with pygitrepo, you are with these powerful tools out-of-the-box:

• make up: single command to create / clean virtual environment.

• make reformat: command to Google stylize your code.

• make install: (For end user) install your package (setup.py file is out-of-the-box).

• make dev_install: (For package developer) install your package in dev mode (setup.py file is out-of-the-box).

• make test: unittest with pytest (tests folder and scripts is out-of-the-box, just follow the pattern and create more).

• make cov: code coverage test with coverage, the default .coveragerc fit most of the case).

• make tox: multi python version test with tox, the default tox.ini fit most of the case.

• built-in integration with https://travis-ci.org/.

• built-in integration with https://codecov.io/.

• make build_doc / view_doc: easy sphinx document writing, no need to run sphinx-quickstart, and write conf.py file.

• make deploy_doc: deploy document to AWS S3.

• make publish: publish your project to PyPI

pygitrepo is compatible with Windows / MacOS / Linux, which means you can enjoy same patterns / commands you use in development everywhere without and file changes.

Usage

Command Line Tool

1. Install: $ pip install pygitrepo.

2. Run command line tool: $ pygitrepo-init, entry your settings following the instruction.

3. A <repo-name> directory will be created, you can use this as your github repo directory.

4. Take a look at Makefile, all magic happens here!

Python Script Initializer

If you want to programmatically initialize your repository, you can do:

import pygitrepo

package_name = "obama_care" # import obama_care
github_username = "Obama"
supported_py_ver = ["2.7.13", "3.4.6", "3.5.3", "3.6.2"]
author_name = "Obama"
author_email = "[e-mail]"
license="MIT"
s3_bucket = "doc-host"
doc_service = "s3" # "none", "rtd", "s3"

if __name__ == "__main__":
    pygitrepo.init(
        package_name=package_name,
        github_username=github_username,
        supported_py_ver=supported_py_ver,
        author_name=author_name,
        author_email=author_email,
        license=license,
        s3_bucket=s3_bucket,
        doc_service=doc_service,
    )

All available options and its definition can be found HERE or THERE.

Install

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

$ pip install pygitrepo

To upgrade to latest version:

$ pip install --upgrade pygitrepo