Cloaca Tutorials
These tutorials will guide you through building workflows with Cloaca. Each tutorial builds upon the previous one to give you a complete understanding of the framework.
Before starting any tutorial, ensure you have:
- Python 3.9 or higher
- pip (Python package installer)
- Basic knowledge of Python
- A code editor of your choice
Each tutorial is designed to be followed in sequence. They build upon each other to give you a complete understanding of how to use Cloaca effectively.
For all tutorials, you’ll need to install Cloaca:
pip install cloaca[sqlite]
pip install cloaca[postgres]
Virtual EnvironmentWe recommend using a virtual environment for the tutorials:
python -m venv tutorial-env source tutorial-env/bin/activate # On Windows: tutorial-env\Scripts\activate pip install cloaca[sqlite]
Each tutorial follows this structure:
- Learning Objectives: What you’ll learn
- Prerequisites: Required knowledge and setup
- Time Estimate: Expected completion time
- Code Examples: Working Python code
- Explanation: Detailed breakdown of concepts
- Exercises: Practice what you’ve learned
- Next Steps: Where to go from here
If you encounter issues:
- Check the API Reference for detailed method documentation
- Review the Examples for more code samples
- Consult the How-to Guides for specific solutions
All tutorial code examples are available in the examples directory of the Cloacina repository.