Protean

Release v0.11.0

Protean is a DDD and CQRS-based framework that helps you build Event-driven applications.

Get started with Installation and then get an overview with the Quickstart.

Warning

Protean’s documentation is Work-In-Progress - there are significant portions of functionality still missing. Refer to the contribution guide to help grow the documentation.

---

Overview

Protean helps you build applications that can scale and adapt to growing requirements without significant rework.

At its core, Protean encourages a Domain-Driven Design (DDD) approach to development, with support for artifacts necessary to express your domain succinctly and precisely. It also allows you to remain agnostic to the underlying technology by keeping implementation details out of view.

Protean can be thought of having three capabilities:

• Service-Oriented - Develop your application as one or more subdomains that run independently as Microservices

• Event-Driven: - Use events to propagate changes across subdomains or become eventually consistent within a Bounded Context.

• Adapter-based: - Use Remain technology-agnostic by exposing Port interfaces to the infrastructure, with multiple adapters supported out of the box.

Read Foreword to understand Protean’s philosophy.

Note

It is assumed that you have some prior knowledge about Domain-Driven Design (DDD) and Command Query Responsibility Segregation (CQRS) architectural patterns.

If you do not have sufficient background in these topics, you should go through standard texts to understand Protean’s behavior better.

Warning

Protean is currently under active development. APIs and interfaces are to be expected to change drastically and newer releases will almost certainly be backward incompatible.

If you are interested in using Protean for your project, you may want to wait for the announcement of first stable production-ready version. If you want to use the framework right now, drop us an email.

---

User Guide

• Foreword
  • Mirror the domain in code
  • Remain technology agnostic
  • Choose the right design pattern
• Installation
  • Install Python
  • Install Protean
  • Verifying
• Quickstart
  • Initialize a Project
  • A Simple Domain
  • Define an Aggregate
  • Define an Application Service
  • Configure a database
  • Initialize the domain
  • Configure Flask
  • Define a route
  • Start the Flask server
  • Access the domain over APIs
• Composing a Domain
  • Define a Domain
  • Registering Elements to the Domain
  • Initializing the Domain
  • Activating a Domain
  • When to compose
• Defining Domain Concepts
  • Aggregates
  • Fields
  • Initialization
  • Identity
  • Inheriting Aggregates
  • Declaring Abstract Base Aggregates
  • Metadata
• Aggregate Elements
  • Entities
  • Relationships
  • Value Objects
  • Embedding Value Objects
  • Examples
• Data Fields
  • Field options
  • Basic Fields
  • Container Fields
  • Associations
  • Embedded Fields
• Persisting Data
  • Saving to Database
  • Retrieving Data
  • Custom Repositories
  • Database-specific Repositories
  • Data Access Objects
  • Working with Application Services
  • Unit of Work
• Exposing the domain
  • Routing requests to Application Services
• Processing Events
  • Defining Domain Events
  • Raising Events
  • Consuming Events
  • Processing Strategies
  • Best Practices
• Event Sourcing
  • Event-Sourced Aggregates
  • Storing Events
  • Snapshots
  • Optimistic Concurrency
• Configuration Handling
  • Configuration Basics
  • Builtin Configuration Values
  • Configuring from Python Files
  • Configuring from Data Files
  • Configuring from Environment Variables
  • Development / Production
• Command Line Interface
  • Application Discovery
  • Run the Development Server

Adapters

• Database Adapters

API Reference

If you are looking for information on a specific function, class or method, this part of the documentation is for you.

• API
  • Core Domain
  • Domain Elements
  • Configuration
  • Exceptions

Community

The best way to track the development of Protean is through the the GitHub repo.

• Release History
• Code of Conduct
• Contributing to Protean