Skip to main content

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

Project description

Documentation Status https://travis-ci.org/MacHu-GWU/pygitrepo-project.svg?branch=master https://codecov.io/gh/MacHu-GWU/pygitrepo-project/branch/master/graph/badge.svg https://img.shields.io/pypi/v/pygitrepo.svg https://img.shields.io/pypi/l/pygitrepo.svg https://img.shields.io/pypi/pyversions/pygitrepo.svg https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social
https://img.shields.io/badge/Link-Document-blue.svg https://img.shields.io/badge/Link-API-blue.svg https://img.shields.io/badge/Link-Source_Code-blue.svg https://img.shields.io/badge/Link-Install-blue.svg https://img.shields.io/badge/Link-GitHub-blue.svg https://img.shields.io/badge/Link-Submit_Issue-blue.svg https://img.shields.io/badge/Link-Request_Feature-blue.svg https://img.shields.io/badge/Link-Download-blue.svg

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pygitrepo-0.0.28.tar.gz (74.1 kB view details)

Uploaded Source

Built Distribution

pygitrepo-0.0.28-py2.py3-none-any.whl (93.4 kB view details)

Uploaded Python 2Python 3

File details

Details for the file pygitrepo-0.0.28.tar.gz.

File metadata

  • Download URL: pygitrepo-0.0.28.tar.gz
  • Upload date:
  • Size: 74.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/2.7.13

File hashes

Hashes for pygitrepo-0.0.28.tar.gz
Algorithm Hash digest
SHA256 af195d2985ef5a36c60210ee14d49c80c51957837f5aaba4065020f450baf657
MD5 b8b93a7e61302c26c98757633449d54f
BLAKE2b-256 5586282567ec905a73bf659c98f1a94b48cf04742ad015b3cddd48fcf0b6608e

See more details on using hashes here.

File details

Details for the file pygitrepo-0.0.28-py2.py3-none-any.whl.

File metadata

  • Download URL: pygitrepo-0.0.28-py2.py3-none-any.whl
  • Upload date:
  • Size: 93.4 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/2.7.13

File hashes

Hashes for pygitrepo-0.0.28-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a9ee636da4c5ef0dbe65a522aab8c3b3f70990fbaa9f758b02b32af669a2c26f
MD5 480903dd15b4ab699a52e53961a523f5
BLAKE2b-256 05f8c9c35fe170daea89c354cfdc371492608b1b0cb6175060e80c6069aa365c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page