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

Welcome to pygitrepo Documentation

pygitrepo can quickly initiate a python project from scratch, 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: install your package (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.

Quick Links

Usage

  1. Install: pip install pygitrepo.

  2. Run command line tool: pygitrepo-init.

  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!

Things Need to Install

For Windows (Git-Bash and MinGW)

Because Windows doesn’t have shell script and make command, so we have to install some third-party software to make it works.

Install Git Bash as shell emulator

  1. Download and install git.

  2. Now you can use C:\Program Files\Git\git-bash.exe like the terminal in MacOS/Linux.

Install MinGW

  1. Download and install, use the installer to install MinGW Base.

  2. Find C:\MinGW\bin\mingw32-make.exe, copy and paste and rename as C:\MinGW\bin\make.exe.

  3. Add C:\MinGW\bin to $PATH (environment variable).

Now you can use make <target> in git-bash.exe now.

For MacOS (HomeBrew)

You have to make sure:

There’s two way of using virtualenv in MacOS:

  1. Use generic virtualenv.

  2. Use pyenv + pyenv-virtualenv.

I prefer pyenv + pyenv-virtualenv, because it allows you:

  1. use tox to test against multiple python version locally before using cloud CI (continues integration).

  2. will not mess up your global python environment.

  3. the Makefile will do the pyenv + pyenv-virtualenv setup for you, just make sure that you have HomeBrew installed.

AWS Command Line (Optional)

Use AWS S3 to host your doc site is a good idea!

We need awscli to automate the deployment.

  1. Install awscli, just pip install awscli.

  2. Configure your API token, just aws configure and follow the instruction.

Config PyPI (Optional)

If you want to publish your package to PyPI or new PyPI, you need a pypi account and Configure your credential.

  1. Create a ${HOME}/.pypirc file.

  2. put these contents:

    [distutils]
index-servers =
    pypi

[pypi]
username:<username>
password:<password>

CI (Continues Integration) (Optional)

  1. Test with travis-ci, basically you just need to:

    • sign in using GitHub account.

    • toggle on your repo.

  2. Code Coverage Test with codecov.

Install

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

$ pip install pygitrepo

To upgrade to latest version:

$ pip install --upgrade pygitrepo

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (1.0.8)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for machugwu from gravatar.com machugwu

Credits

Author: Sanhe Hu

License

MIT License (MIT)

Classifiers

Report project as malware

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.7.tar.gz (48.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pygitrepo-0.0.7-py2-none-any.whl (57.1 kB view details)

Uploaded Python 2

File details

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

File metadata

  • Download URL: pygitrepo-0.0.7.tar.gz
  • Upload date:
  • Size: 48.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for pygitrepo-0.0.7.tar.gz
Algorithm Hash digest
SHA256 6af87c7daaa56b6cae287b2dbfa98eb9fdfb37a7118c539f0db27b77b72fd734
MD5 c155edf529c8341a3ca5f791f5a673a7
BLAKE2b-256 e485abe4926a37654ea634180dbcac3266121106df6fe2a211e0ba19c8181d60

See more details on using hashes here.

File details

Details for the file pygitrepo-0.0.7-py2-none-any.whl.

File metadata

File hashes

Hashes for pygitrepo-0.0.7-py2-none-any.whl
Algorithm Hash digest
SHA256 952eefbf9f0d327cf21d5f221e8314266112ffa6d12d10b1cfe1e0ca9a1252da
MD5 446ecc426b47a38eca221575b8a37ed6
BLAKE2b-256 94ab75c2f45c4664e898d6331e522a1aba5426442c8526dbfe0d6291abd0412f

See more details on using hashes here.

Release history Release notifications | RSS feed

1.0.8

2 files

1.0.7

2 files

1.0.6

2 files

1.0.5

2 files

1.0.4

2 files

1.0.3

2 files

1.0.2

2 files

1.0.1

2 files

0.0.28

2 files

0.0.27

2 files

0.0.26

2 files

0.0.25

2 files

0.0.24

2 files

0.0.23

2 files

0.0.22

2 files

0.0.21

2 files

0.0.20

2 files

0.0.19

2 files

0.0.18

2 files

0.0.17

2 files

0.0.16

2 files

0.0.15

2 files

0.0.14

2 files

0.0.13

2 files

0.0.12

2 files

0.0.11

2 files

0.0.10

2 files

0.0.9

2 files

0.0.8

2 files

This release

0.0.7 This release

2 files

0.0.6

2 files

0.0.5

2 files

0.0.3

2 files

0.0.2

2 files

0.0.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page