Skip to main content

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

Project description

.. image::

.. image::

.. image::

.. image::

.. image::

.. image::!--None.svg?style=social

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

- .. image::

- .. image::

- .. image::
:target: `install`_

- .. image::

- .. image::

- .. image::

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 (```` file is out-of-the-box).
- ``make dev_install``: (For package developer) install your package in dev mode (```` 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
- built-in integration with
- ``make build_doc / view_doc``: easy sphinx document writing, no need to run ``sphinx-quickstart``, and write ```` 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.


**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:

.. code-block:: python

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 = ""
s3_bucket = "doc-host"
doc_service = "s3" # "none", "rtd", "s3"

if __name__ == "__main__":

All available options and its definition can be found `Here <>`_ or `Here <>`_.

.. _install:


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

.. code-block:: console

$ pip install pygitrepo

To upgrade to latest version:

.. code-block:: console

$ 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.15.tar.gz (61.6 kB view hashes)

Uploaded Source

Built Distribution

pygitrepo-0.0.15-py2-none-any.whl (86.6 kB view hashes)

Uploaded Python 2

Supported by

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