Programme¶
- Dependencies
- github account
- readthedocs account
- pypi account
- python 3.6
- cookiecutter
- if working in teams use a simple editor with no frills (VSCode is great)
- Write a python module that serves as HTTP client for a public API (httpbin.org)
- Create a setup.py
- declare dependencies
- name, description and version
- long description as rst docstring
- add trove classifiers PEP 0301
- pick an open source license
- MIT if you don’t care
- GPL for viral recognition
- Publishing a package
- Adding command-line entrypoints
- Distributing package data
- Define extra dependencies (such as requests[security])
- Writing tests
- Tooling: Nose (and rednose vs. pinocchio), Sure, HTTPretty, Coverage
- Unit, Functional and Integration
- Collecting coverage
- Run tests on Travis
- Writing docs
- Generate API reference from code
- Syntax for function or method params and return values
- Use intersphinx to reference other libraries documented with sphinx
- Did you know about
objects.inv
?
- Did you know about
- Publish docs with ReadTheDocs