Pythonect is under active development, and contributors are welcome.
If you have a feature request, suggestion, or bug report, please open a new issue on GitHub. To submit patches, please send a pull request on GitHub.
If you'd like to contribute, there's plenty to do. Here's a short todo list.
Pythonect source is controlled with Git, the lean, mean, distributed source control machine.
The repository is publicly accessible.
git clone git://github.com/ikotler/pythonect.git
The project is hosted on GitHub:
http://github.com/ikotler/pythonect
Feature / Hotfix / Release branches follow a Successful Git Branching Model. Git-Flow is a great tool for managing the repository. I highly recommend it.
develop- The "next release" branch. Likely unstable.
master- Current production release (|version|) on PyPi.
Each release is tagged.
When submitting patches, please place your feature/change in its own branch prior to opening a pull request on GitHub.
Testing is crucial to Pythonect's stability. When developing a new feature for Pythonect, be sure to write proper tests for it as well.
The easiest way to test your changes for potential issues is to simply run the test suite directly:
$ python setup.py nosetests
Don't have nose installed? Installing nose is simple:
$ pip install nose
Every commit made to the develop branch is automatically tested and inspected upon receipt with Travis CI. If you have access to the main repository and broke the build, you will receive an email accordingly.
Anyone may view the build status and history at any time:
https://travis-ci.org/ikotler/pythonect
Documentation is written in the powerful, flexible, and standard Python documentation format, reStructured Text. Documentation builds are powered by the powerful Pocoo project, Sphinx. The :ref:`API Documentation <api>` is mostly documented inline throughout the module.
The Docs live in pythonect/doc. In order to build them, you will first need to install Sphinx:
$ pip install sphinx
Then, to build an HTML version of the docs, simply run the following from the doc directory:
$ make html
Your doc/_build/html directory will then contain an HTML representation of the documentation, ready for publication on most web servers.
You can also generate the documentation in epub, latex, and json.