pysharedutils User Documentation¶
pysharedutils¶
pysharedutils is a convenient utility module which are not included in standard Python install.
Installation¶
pysharedutils is available on PyPI, so to use it you can use pip:
To install pysharedutils, simply run:
$ pip install pysharedutils
Alternatively, if you don’t have setuptools installed, download it from PyPi and run:
$ python setup.py install
Also, you can get the source from GitHub and install it as above:
$ git clone https://github.com/joeljames/py-shared-utils.git
$ cd pysharedutils
$ python setup.py install
- Examples
- Some quick usage examples.
Changes¶
See the Changelog for a full list of changes to py-shared-utils.
Note
Always read changelog documentation before putting updates live in production.
Contribute¶
Always looking for contributions, additions and improvements.
The source is available on GitHub and contributions are always encouraged.
To contribute, fork the project on GitHub and submit a pull request. If you have notices bugs or issues with the library, you can add it to the Issue Tracker.
Install development requirements. It is highly recommended that you use a virtualenv, and activate the virtualenv before installing the requirements.
Install project requirements:
$ pip install -r requirements.txt
Run tests with coverage:
$ make unit_test
Run test Using Tox (Runs the tests in different supported python interpreter):
$ tox
Run Lint:
$ make lint
Create a new local branch to submit a pull request:
$ git checkout -b name-of-feature
Commit your changes:
$ git commit -m "Detailed commit message"
Push up your changes:
$ git push origin name-of-feature
Submit a pull request. Before submitting a pull request, make sure pull request add the functionality, it is tested and docs are updated.