Skip to main content

A scaffoling tool for python packages

Project description

A very simple scaffold for constructing python packages

Installation

  • run pip install python-git-package

Introduction

This package can be used for scaffolding new packages. The command pgp init creates a new package in the current folder. The command pgp release creates a new release. The command pgp doc builds the docs using sphinx.

The package layout is as follows:

mypackage
 |-- .git
 |-- doc
 |    |--source
 |        |-- _static
 |        |-- _templates
 |        |-- conf.py
 |        |-- index.rst
 |        |-- mypackage.rst
 |
 |-- examples
 |-- mypackage
 |    |-- __init__.py
 |    |-- __version__.py
 |    |-- mypackage.py
 |
 |-- tests
 |    |-- all.py
 |    |-- test_mypackage.py
 |
 |-- .gitignore
 |-- LICENSE
 |-- MANIFEST.in
 |-- README.rst
 |-- setup.py

All files are populated with basic content so the notorious task of manually creating setup.py```or ``manifest.in is taken out of the users task.

Furthermore, the init command initializes a git repository with two branches, master and dev in the package folder. The master branch is intended for published releases only. It should allwats point to the latest release. The dev branch is used for develloping the package. To ease the process of creating a new release

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

python-git-package-0.3.1.tar.gz (57.5 kB view details)

Uploaded Source

File details

Details for the file python-git-package-0.3.1.tar.gz.

File metadata

File hashes

Hashes for python-git-package-0.3.1.tar.gz
Algorithm Hash digest
SHA256 f9c3d6d62a1bf96b7c3b76e7b54ec9dbcbe00a32ca50a8ca94f84617227cb318
MD5 424a7cb5d1060598dca2bd9abef1a0b3
BLAKE2b-256 a1ef54659a639fe92d3cc5b0c306035bf89d0d5da2f1c84d25a80604414b509e

See more details on using hashes here.

Supported by

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