Privex Python Helpers’s documentation¶

Welcome to the documentation for Privex’s Python Helpers - a small, open source Python 3 package containing a variety of functions, classes, exceptions, decorators and more - each of which would otherwise be too small to maintain in an individual package.

This documentation is automatically kept up to date by ReadTheDocs, as it is automatically re-built each time a new commit is pushed to the Github Project

Contents¶

Installation¶

Download and install from PyPi using pip (recommended)¶

pip3 install privex-helpers

(Alternative) Manual install from Git¶

Option 1 - Use pip to install straight from Github

pip3 install git+https://github.com/Privex/python-helpers

Option 2 - Clone and install manually

# Clone the repository from Github
git clone https://github.com/Privex/python-helpers
cd python-helpers

# RECOMMENDED MANUAL INSTALL METHOD
# Use pip to install the source code
pip3 install .

# ALTERNATIVE MANUAL INSTALL METHOD
# If you don't have pip, or have issues with installing using it, then you can use setuptools instead.
python3 setup.py install

Code Docs for each helper module¶

`privex.helpers.common`	Common functions and classes that don’t fit into a specific category
`privex.helpers.decorators`	Class Method / Function decorators
`privex.helpers.django`	This module file contains Django-specific helper functions, to help save time when developing with the Django framework.
`privex.helpers.exceptions`	Exception classes used either by our helpers, or just generic exception names which are missing from the standard base exceptions in Python, and are commonly used across our projects.
`privex.helpers.net`	Network related helper code
`privex.helpers.plugin`	This module handles connection objects for databases, APIs etc.
`privex.helpers.settings`	Configuration options for helpers, and services they depend on, such as Redis.

Unit Tests¶

tests

This file contains test cases for Privex’s Python Helper’s (privex-helpers).