Skip to main content

Simple project scaffolding for Python

Project description

h1. Scaffold for Python

Inspired by “Zed Shaw’s”: recommended Python project structure from “Learn Python the Hard Way”: exercise “#46”:

Each project you scaffold will create the following directory structure:

<pre> /[projectname]/ /[projectname]/ /[projectname]/bin /[projectname]/docs /[projectname]/[projectname] /[projectname]/[projectname]/ /[projectname]/tests /[projectname]/tests/ /[projectname]/tests/[projectname] </pre>

Both and @[projectname] are set up automatically to reference your project name as a module. The rest is up to you!

h2. Installing Scaffold

You can view the scaffold package on PyPi here: “”:

To install, simply use @pip install scaffold@

h2. Running Scaffold

Scaffold installs itself as an executable Python script, so just enter this on your command line:

<pre>pyscaffold -p “projectname” [-d {base directory}]</pre>

The @-p@ parameter is the name of your project and is a required field. If you don’t specify a base directory with the @-d@ parameter, scaffold will assume that you want to create your project skeleton in your current working directory.

h3. Sample Usage:

Just to give you an idea of what works and what doesn’t…

<pre>pyscaffold -p “http-utils” -d /c/repositories/ pyscaffold -p “mutliplex-py” pyscaffold -p “lazarus” -d ../</pre>

h2. License

Licensed under Apache 2.0 - see license.txt for details.

h2. Contribution

I’m not the most experienced Python programmer on the planet, so patches are most certainly welcome :) -“Aaron Stannard”:

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 (9.8 kB view hashes)

Uploaded Source

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