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

Uploaded Source

File details

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

File metadata

File hashes

Hashes for python-git-package-0.3.3.tar.gz
Algorithm Hash digest
SHA256 52175499296c4339b38af7568af652a53be168dbf79add8b587bda19f76cc56f
MD5 dc59ae78aaf2b1615db4f3ebd7cb218a
BLAKE2b-256 ee27f4cea79bd134321ccf0c8496e18210e044aba8a4747758e6ac622ea8bb97

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