If you would like to contribute to the Blogofile project, these instructions should help you get started. Patches, documentation improvements, bug reports, and feature requests are all welcome through the GitHub projects:
Contributions in the form of patches or pull requests are easier to integrate and will receive priority attention.
Blogofile is developed under Python 3.2 and tested with Python 2.6, 2.7, 3.2, and 3.3.
Setting Up a Development Sandbox¶
Using a Python virtualenv is strongly recommended to segregate Blogofile and the packages it depends on from your system Python installation.
Create a virtualenv and activate it:
$ virtualenv blogofile-dev $ source blogofile-dev/bin/activate
Grab the Blogofile core, and the blogofile_blog reference plugin repos from GitHub:
(blogofile-dev)$ cd blogofile-dev (blogofile-dev)$ git clone git://github.com/EnigmaCurry/blogofile.git (blogofile-dev)$ git clone git://github.com/EnigmaCurry/blogofile_blog.git
Install the packages for development, and install the extra packages that are used to build the docs and run the test suite:
(blogofile-dev)$ pip install -e blogofile (blogofile-dev)$ pip install -e blogofile_blog (blogofile-dev)$ pip install -r blogofile/requirements/develop.txt
blogofile/docs/ directory includes a
Makefile to help
build the docs:
(blogofile-dev)$ (cd blogofile/docs && make html) sphinx-build -b html -d _build/doctrees . _build/html Making output directory... Running Sphinx v1.1.3 loading pickled environment... not yet created building [html]: targets for 12 source files that are out of date updating environment: 12 added, 0 changed, 0 removed reading sources... [100%] vcs_integration looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done writing output... [100%] vcs_integration writing additional files... genindex search copying static files... done dumping search index... done dumping object inventory... done build succeeded. Build finished. The HTML pages are in _build/html.
The output version of the docs ends up in
in your development sandbox.
To run the tests under Python 2.6, 2.7, and 3.2,
run tox in the top level
To run tests under a single version of Python, specify the appropriate environment when running tox:
$ tox -e py27
Add new tests by modifying an existing file or adding a new one in the
Blogofile and blogofile_blog releases are hosted on PyPI and can be downloaded from:
The source repositories are hosted on GitHub:
Please report bugs through the GitHub projects: