Welcome to the groundwork tutorial

This tutorial guides you through the creation of a groundwork based application.

It starts with a simple commandline script for monitoring csv file changes, adds a database in the second chapter for storing the change history and finally shows you how to create a complete web application based on the initial script.

This is a bottom-up tutorial and therefore new code and functions are getting added with each new chapter. If you get lost or your code is not working as expected, try to catch a fresh code base from our git repository at https://github.com/useblocks/groundwork-tutorial.

groundwork framework

groundwork is a plugin-based Python Application framework.

To get a first impression of it, visit http://groundwork.useblocks.com or read its technical documentation.

Contents:

• 1. groundwork basics
  • 1.1. Introduction
  • 1.2. Installation
  • 1.3. Usage
  • 1.4. First own project
  • 1.5. First own plugin
  • 1.6. First own pattern
  • 1.7. Adding signals and receivers
  • 1.8. Using configs and documents
• 2. groundwork and databases
  • 2.1. Simple watcher database
  • 2.2. Complex history database
• 3. groundwork and the web
  • 3.1. Web application setup
  • 3.2. Database views made simple
  • 3.3. Creating own web content
• 4. Appendix
  • 4.1. Python
  • 4.2. Sphinx
  • 4.3. PyTest
  • 4.4. Tox
  • 4.5. Logging
  • 4.6. Buildout
  • 4.7. SQLAlchemy
  • 4.8. Cookiecutter
  • 4.9. Jinja
  • 4.10. REST
  • 4.11. useblocks convention of Python development
  • 4.12. Training agenda
  • 4.13. Somehow related links
• 5. Final API
  • 5.1. csv_manager package