A crash course to writing Django modules

Django has a vast ecosystem of 3rd party modules. This crash course is an attempt at writing a guide for writing, testing, documenting and deploying such modules to Pypi - the Python Package Index.

The concepts in this guide does not strictly apply just to Django, but can with minor adjustments be used as a guideline for writing all sorts of portable Python modules.

It is not however; a tutorial for Python nor Django. If you are new to Django, I suggest you complete the Django tutorial first, then come back and read the crash course.

Contents:

• Working environment
  • Installing virtualenv and virtualenvwrapper
  • Creating a virtual environment for the project
• Project structure
  • Setting up the project
  • Write some code
• Testing
  • The setup script
  • Setting up the test runner
  • Running the test suite
  • Writing a test case
  • Testing multiple environments
  • Continuous Integration
• Documenting your library
  • Writing documentation
  • Compile the documentation
  • Read the Docs
• Pack and deploy your masterpiece!
  • Push the library to PyPi
• Conclusion

Indices and tables

• Index
• Module Index
• Search Page