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.0.zip (31.4 kB view details)

Uploaded Source

File details

Details for the file python-git-package-0.3.0.zip.

File metadata

File hashes

Hashes for python-git-package-0.3.0.zip
Algorithm Hash digest
SHA256 55414732e1ef7afcfc2ed7f014c30e0b730049ec955e03d4f95cc4210a27baa1
MD5 7d9666807bffaadcf94460298258ee72
BLAKE2b-256 8559f1761bc8ec87cce35dd146bfbe368ba33e36fc16823d5e13c89fdbfa17f0

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