4. Appendix

The appendix is a collection of generic topics and libraries, which are used or supported by groundwork and its extensions.

The following sites give a rough overview about the related topic/library without any link to the used example code of this tutorial. They are here to provide you an easy accessible entry point to dive deeper…

Contents:

• 4.1. Python
  • 4.1.1. Introduction
  • 4.1.2. Links
  • 4.1.3. Usage
• 4.2. Sphinx
  • 4.2.1. Introduction
  • 4.2.2. Links
  • 4.2.3. Usage
  • 4.2.4. Restructured text (rst)
  • 4.2.5. API documentation
  • 4.2.6. Useful Extensions
• 4.3. PyTest
  • 4.3.1. Introduction
  • 4.3.2. Links
  • 4.3.3. Usage
• 4.4. Tox
  • 4.4.1. Introduction
  • 4.4.2. Links
  • 4.4.3. Usage
• 4.5. Logging
  • 4.5.1. Introduction
  • 4.5.2. Links
  • 4.5.3. Usage
• 4.6. Buildout
  • 4.6.1. Introduction
  • 4.6.2. Links
  • 4.6.3. Usage
• 4.7. SQLAlchemy
  • 4.7.1. Introduction
  • 4.7.2. Links
  • 4.7.3. Usage
• 4.8. Cookiecutter
  • 4.8.1. Introduction
  • 4.8.2. Links
  • 4.8.3. Usage
• 4.9. Jinja
  • 4.9.1. Introduction
  • 4.9.2. Links
  • 4.9.3. Usage
• 4.10. REST
  • 4.10.1. Introduction
  • 4.10.2. Links
  • 4.10.3. Usage
• 4.11. useblocks convention of Python development
  • 4.11.1. We keep all stuff, which belongs together, inside one repository
  • 4.11.2. We can open all stuff, which is developed by us, in our IDE
  • 4.11.3. We write and use tests
  • 4.11.4. We write and publish user documentation
  • 4.11.5. We publish code, tests, documentation as versioned package
  • 4.11.6. We use logging libraries inside our tools
  • 4.11.7. We provide configuration capabilities for our tools
  • 4.11.8. We use exceptions
  • 4.11.9. We have and follow coding rules
  • 4.11.10. We write tons of documentation inside our code
  • 4.11.11. We are using continuous integration with ruthless tests
• 4.12. Training agenda
  • 4.12.1. Day 1
  • 4.12.2. Day 2
• 4.13. Somehow related links
  • 4.13.1. Joel on Software Blog