Skip to main content

pythonbase is a skeleton for creating Python projects

Project description

pythonbase provides a skeleton for creating Python projects, complete with Sphinx docs, PyPI integration, etc.

Basic setup

  1. Copy the directory structure and files of Pythonbase to your project.

  2. Make changes to all these files as necessary (e.g., by grep’ing for “pythonbase” and replacing with your project).

  3. Run python setup.py develop in your new project to install it on your system

  4. Run python setup.py release to release your project to PyPI. Congratulations, your project can now be installed!

(The last step probably requires PyPI registration; fill in details once I get a good test case for a new user).

Docs setup

  1. Navigate to the pythonbase/docs directory

  2. Run sphinx-apidoc -o . -f ../pythonbase; make html

  3. Go up one directory (cd..).

  4. Release docs: python setup.py upload_docs --upload-dir=docs/_build/html

CircleCI setup

  1. Log into CircleCI, and build your project.

The Pythonbase docs are located as here

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

pythonbase-0.0.2.tar.gz (342.7 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