Skip to main content

A scaffolding 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.4.tar.gz (58.4 kB view details)

Uploaded Source

File details

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

File metadata

File hashes

Hashes for python-git-package-0.3.4.tar.gz
Algorithm Hash digest
SHA256 250cb34c5591ba39c23168c83998fe37c81a461c4cbec27aa5805192be688784
MD5 75e76efbe0f5656b28427b6f06304ccc
BLAKE2b-256 55c6ed2be0069551c59416fb24ca4924199e1241acffde37edb961588e8184b6

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