Skip to main content

Tool for easily putting up the scaffold for a Python project

Project description

https://travis-ci.org/blue-yonder/pyscaffold.svg?branch=master https://coveralls.io/repos/blue-yonder/pyscaffold/badge.png

PyScaffold helps you to easily setup a new Python project, it is as easy as:

putup my_project

Type putup -h to learn about more configuration options. PyScaffold assumes that you have Git installed and set up on your PC, meaning at least your name and email configured. The scaffold of my_project provides you with following features:

Packaging

Run python setup.py sdist, python setup.py bdist or python setup.py bdist_wheel to build a source, binary or wheel distribution.

Complete Git integration

Your project is already an initialised Git repository and setup.py uses the information of tags to infer the version of your project with the help of versioneer. To use this feature you need to tag with the format vMAJOR.MINOR.REVISION, e.g. v0.0.1 or v0.1. The prefix v is needed! Run python setup.py version to retrieve the current PEP440-compliant version. The version will be unknown until you have added a first tag.

Sphinx documentation integration

Build the documentation with python setup.py docs and run doctests with python setup.py doctest. Start editing the file docs/index.rst to extend the documentation.

Unittest integration

Run python setup.py test to run all unittests defined in the subfolder tests with the help of py.test.

Requirements management

Add the requirements of your project to the requirements.txt file which will be automatically used by setup.py.

Project details


Release history Release notifications | RSS feed

This version

0.2

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyscaffold-0.2.tar.gz (26.3 kB view details)

Uploaded Source

File details

Details for the file pyscaffold-0.2.tar.gz.

File metadata

  • Download URL: pyscaffold-0.2.tar.gz
  • Upload date:
  • Size: 26.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for pyscaffold-0.2.tar.gz
Algorithm Hash digest
SHA256 4e8f9a3de669db3c42d1295baf9bf54d3ea684e748d2f862234a1e8796fa9089
MD5 fd0d7f5cd8cf7e73a907f2165955d5f5
BLAKE2b-256 e8f8bd5829d7a7d8be1ff387a3f60c61e77ac6dc33d3d4c980997adbe91aafd9

See more details on using hashes here.

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