All you should know before developing

If you are not redirected to this page from the API training materials, you should go through the materials there and get yourself familiarized with the API first. This project is a simple Python wrapper for our CAM2 Camera Database API; we should not reproduce data processing logic that is already in API routes.

Python Client Developing and Testing

• Requests module documentation - http://docs.python-requests.org/en/master/user/quickstart/
• Mocking API requests in unittest tutorial 1 - http://engineroom.trackmaven.com/blog/real-life-mocking/
• Mocking API requests in unittest tutorial 2 - https://auth0.com/blog/mocking-api-calls-in-python/

Writing Documentation

We are using Sphinx numpy style documentation. Documentation will be automatically generated by CircleCI and push to gh-pages branch when there is a merge to master. Admins should get familiarized with how the documentation is generated by referring to the .circleci/generate_docs.sh file.

You should be able to find the hosted CAM2 Camera Database API Python Client documentation here.

• Sphinx Configurations (conf.py) - http://www.sphinx-doc.org/en/master/usage/configuration.html
• How to write numpy style docstring - https://numpydoc.readthedocs.io/en/latest/format.html
• Another good numpy style docstirng guide from pandas - https://python-sprints.github.io/pandas/guide/pandas_docstring.htm
• Pythonic way to organize documentation content structure - http://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#toctree-directive

Python Client Packaging

• Packaging Python Project to allow pip install (optional; for admins) - https://packaging.python.org/tutorials/packaging-projects/