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
Install: $ pip install pygitrepo.
Run command line tool: $ pygitrepo-init, entry your settings following the instruction.
A <repo-name> directory will be created, you can use this as your github repo directory.
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 = "example@email.com"
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 pygitrepoTo upgrade to latest version:
$ pip install --upgrade pygitrepo1 maintainer
Metadata
1 maintainer
Release files for pygitrepo 0.0.20
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pygitrepo-0.0.20.tar.gz | 49.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pygitrepo-0.0.20-py2-none-any.whl | Python 2 | none | any | Details |
Total release size: 106.8 kB
Release files / pygitrepo-0.0.20.tar.gz
| Download URL | pygitrepo-0.0.20.tar.gz |
|---|---|
| Size | 49.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4a883e171438c56250d894769b74d3309e326884da6723a5c3b1603652032e6a
|
|
BLAKE2b-256 checksum How to use checksums |
e2721ed86722372e1da27df9ea07400828f7bc9d0cac76ed8d54df70c3386611
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / pygitrepo-0.0.20-py2-none-any.whl
| Download URL | pygitrepo-0.0.20-py2-none-any.whl |
|---|---|
| Size | 56.9 kB |
| Tags | Python 2 |
|
SHA-256 checksum How to use checksums |
c37a78af20a7d6d314c871abf6097df82159741749d8f955de2388afc317a1f8
|
|
BLAKE2b-256 checksum How to use checksums |
e50b8d6a1187f6b289c38ed5a169860f38e4a432c0b8a3f361b39cfa99d60772
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
