1. User Guide¶
This section of the documentation provides user focused information such as installing and quickly using this package.
1.1. Install Guide¶
Note
It is best practice to install run Python projects in a virtual environment, which can be created and activated as follows using Python 3.6+.
$ python -m venv venv
$ source venv/bin/activate
(venv) $ pip install apikeeper
The simplest way to install apikeeper is using Pip.
$ pip install apikeeper
This will install apikeeper and all of its dependencies.
1.2. API Reference¶
The API Reference provides API-level documentation.
1.4. Report Bugs¶
Report bugs at the issue tracker.
Please include:
- Operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
