protean 0.8.3

Protean Application Framework

Protean helps you build software on architecture stacks that need to survive in the ever changing technology landscape.

Installation

pip install protean

Documentation

Online docs are available at: https://protean.readthedocs.io/en/latest/

How to Contribute

1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.

2. Fork [the repository](https://github.com/proteanhq/protean) on GitHub to start making your changes to the master branch (or branch off of it).

3. Write a test which shows that the bug was fixed or that the feature works as expected.

4. Send a pull request and bug the maintainer until it gets merged and published. :) Make sure to add yourself to [AUTHORS](https://github.com/proteanhq/protean/blob/master/AUTHORS.rst).

On shoulders of giants…

Protean is not built in a vacuum. Principles and philosophies that Protean espouses are contributions from multiple sources, especially the Open Source Community. It not only refers to well-published architectural ideas and design patterns but also heavily draws inspiration from concrete implementations.

Specifically, Protean is majorly influenced by the venerable Django Framework, and that reflects in many aspects of its underlying constructs and documentation. Thank you, Django, and the Python community, for showing what’s possible.

[ ~ Dependencies scanned by PyUp.io ~ ]

Release History

0.8.3

• Upgrade Elasticsearch client to v8 to resolve urllib3 security vulnerability (#962)

0.8.2

• Add support for PostgreSQL schema switching

• Resolve Elasticsearch index name during connection

• Treat '' value as None in Date and DateTime fields (#365)

0.8.1

• Allow custom separator in Elasticsearch namespaces

0.8.0

• Move fields module to be under main package

• Allow List fields to contain Dict objects

• Elasticsearch adapter bugfixes and model enhancements

• Make views stateful to allow persistence and retrieval

• Auto-generate Event’s message_id

• Support pickling of Protean exceptions

• Bugfix - Fetch view objects instead of simply IDs in cache.get_all()

• Bugfix - Generate embedded ValueObject’s data properly in to_dict()

• Bugfix - Derive SQLAlchemy field types correctly for embedded value object fields

0.7.0

• Simplify Container structure and refactor metaclass usage

• Migrate data elements to inherit from BaseContainer

• Remove meta_ fields and use module functions

• Resolve associated classes dynamically and on domain activation

• Remove custom Meta classes and replace with Options

0.6.2

• Bugfixes for protean start command

• Use _entity as the field identifier for Element-level errors

0.6.1

• Fix to adapt celery broker to new message payload format

0.6.0

• Introduce Async Standalone Server

• Add all() method to repository

• Introduce Cache Port into Protean

• Introduce View elements into Protean

• Add support for add_* and remove_* methods for HasMany relationships

• Enhance Entity.to_dict() to output fully-formed JSON

• Fix HasOne issue with updating an item

• Fix HasMany issue with updating items within UnitOfWork

• Refactor ContainerMeta class to be generic for all elements

• Introduce Makefile with useful test/development commands

• Remove order_by from EntityMeta options

• Validate for Repository’s database meta value

• Make ValueObject’s aggregate linkage optional

• Allow specifying associations with simple Class Names (instead of FQDNs)

• Refactor field class and remove unnecessary attributes (value, label)

• Validate for unique values on saving Entities

• Introduce Docker Compose for all services

• Upgrade SQLAlchemy to support >=1.4.9

• Upgrade to Elasticsearch 7.13.0

• Support case-insensitive match in Elasticsearch

• Ensure compatibility from 3.7 to 3.10

• Migrate to Github Actions from Travis

0.5.8

• Fix Issue with timestamps in EventLog

0.5.7

• Add support for locking a custom repository to a specific database

• Add support for use_ssl and verify_certs options in Elasticsearch database definition

0.5.6

• Lock down celery to 4.4.x version

• Re-Add support for restricting model to a specific database

0.5.5 (2020-09-28)

• Introduce Views (a.k.a Read Models)

• Refactor Domain Module to be leaner

• Introduce Class Factories for all Domain Elements

• Rename impl to adapters

• Add separate ports module with interfaces

• Remove bounded_context definition everywhere

• Rename dict_repo to memory

• Remove *_repo from DB adapter module names

• Rename celery and inline broker module names

• Rename sendgrid email module name

0.5.4 (2020-09-22)

• Add support to restrict a model to a specific database

• Add support for optional pickling of List fields (leverage Postgres List support)

• Add support for Overlap operator in SQLAlchemy repo for Postgresql

• Bugfix - Return keys as Strings for Dict field

• Add support for storing Array of dictionaries in Postgres JSON column

• Bugfix - Validate unique constraints in Dictionary repo

• Bugfix - Fix broken Entity construction from Elasticsearch model

0.5.3 (2020-08-17)

• Allow Postgres Models to choose b/w Pickle or Custom Types for Array and JSON

• Add support for Any operator/lookup for Postgres

0.5.2 (2020-08-06)

• Introduce support for Postgresql Array and JSON columns

• Allow restricting List datatype to specific content types

0.5.1 (2020-07-02)

• Log Protean exceptions to print helpful debug messages

• Support for installation of optional dependencies

• Remove support for Data Transfer Object

• Remove support for Request and Response Objects

• Bugfix - Throw Exceptions on Unit of Work commit failures

• Use black as code formatter, with a git pre-commit hook

• Add 3.9 to test matrix and cleanup Travis yml

• Bugfix - Fix broken Sphinx docs build

0.5.0 (2020-05-01)

• Bugfix #304 - Remove shadow object linkages with aggregates

• Raise InvalidDataError on invalid attributes to Commands

• Treat meta attributes like auto_fields and mandatory_fields as dicts instead of tuples

• Add support for nested serializers/schemas with Marshmallow

• Bugfix to not link shadow fields with Aggregate/Entity classes directly

• Bugfix to set initialize Shadow (Reference) and Value Object attributes correctly

• Store Reference and Value Object fields in Entity.meta_ for later use

• Allow Subscribers and Handlers to hook into multiple Events

• Bugfix to avoid fetching child records without foreign key linkages

• Add support for Dict serialization

• Allow persisting and management of child entities via the Aggregate object

• Add support for using Celery as the background worker

0.4.0 (2020-03-16)

• Add support for referencing embedded fields with a defined name

• Fix to allow default=False on Boolean fields and subsequent filtering for False in field values

• Fix to use Entity attributes to derive field names of unique fields, instead of declared_fields

• Add support for logging events into a universal EventLog table before publishing to brokers

• Add support for custom models associated with Aggregates/Entities

• Use Elasticsearch specific List and Dict attributes to reconstruct entity

• Bugfix - Verify that ValueField object is not empty before trying to access its attributes

• Bugfix - Fix how Elasticsearch connection is fetched while resetting data

0.3.3 (2020-01-10)

• Email Notifications Functionality

• Support for SendGrid

• Allow ad-hoc Identity Generation

0.3.2 (2019-10-17)

• Auto-traversal bug fixes

0.3.1 (2019-10-15)

• Auto Traverse Domain Modules and load elements

0.3 (2019-10-09)

• Add a defaults method as part of Container objects when assigned defaults in one field based on another

• Add support for Command Handlers

• Avoid raising ValidationError when loading data from data stores

• Add support for Elasticsearch as a repository

• Add support for using Redis as a broker with RQ background workers

0.2 ((2019-09-16)

• New Request Object elements introduced to package information from API/views

• A base Container class introduced for all Protean data objects for uniformity in behavior

• Support for specifying Data Type of auto-generated Identities (String, Integer or UUID)

• Enhancements and fixes for Unit of Work functionality to work well with SQLAlchemy type database plugins

• Unit of Work transactions now control event publishing and release events to the stream only on a successful commit

• A Simplified element registration process to the domain

• Validation bug fixes in Aggregates, Entities and Value Objects

• Fully functional and configurable logs throughout Protean codebase

• Test case restructuring for clarity and isolation of configurations

0.1 (2019-07-25)

• Full revamp of Protean codebase to adhere to DDD principles

• Add Domain Composition root, with support for the definition of multiple domains in a project

• Support for Domain Layer elements: Aggregates, Entities, Value Objects, Domain Services, and Events

• Support for Application Layer elements: Application Services, Data Transfer Objects, Repositories, Subscribers and Serializers

• Support annotations to register elements with Domain

• Complete revamping of Repository layer, and introduction of an underlying DAO layer

• Add Unit of Work capabilities to support ACID transactions

• Collapse SQLAlchemy and Flask implementations in Protean itself temporarily, until API stabilizes

• Rename success flag on Response to is_successful

• Rename message attribute in Response object to errors with a uniform structure in all error cases

0.0.11 (2019-04-23)

• Rename Repository abstract methods to be public (Ex. _create_object → create)

• Add delete_all() method to Entity to support Repository cleanup

• Add support for raw queries on Entity repositories

• Remove requirement for explicit Model definitions for Entities

• Move Model options into Entity Meta class

• Support for pre_save and post_save entity callbacks

• Replace Pagination with ResultSet because it is at Entity and Use Case level

• Replace page and per_page with limit and offset

• Add Command utility to generate Protean project template

• Provide command line utilities for –version and test

• Bug fix: Handled quotes and escape properly in string values in Dictionary repository

• Add documentation for Overriding Entity Life cycle methods

• Add ability to mark tests as slow and run slow tests in travis

0.0.10 (2019-04-05)

• Support for chained update and delete methods on Queryset

• Support for update_all method for mass updates on objects

• Support for delete_all method for mass deletion of objects

• Rename databases configuration key in Config file from REPOSITORIES to DATABASES

• Fully expand the Provider class in configuration file, to avoid assuming a Provider class name

• Split Adapter class into Provider and Repository, separating the concern of managing the database connection from performing CRUD operations on Entity data

• Expose configured databases as providers global variable

• Allow fetching new connection on demand of a new repository object via get_connection in providers

• Rename Lookup class to BaseLookup

• Associate Lookups with Concrete Provider classes

• Provide option to fully bake a model class in case it needs to be decorated for a specific database, via the get_model method in concrete Provider class

• Add support for Entity Namespaces

• Refactor Repository Factory for better consistency of registry

0.0.9 (2019-03-08)

• Minor fixes for issues found while migrating SQLAlchemy plugin to 0.0.8 version

• delete method should query by value of id_field instead of hard-coded id

0.0.8 (2019-02-27)

• Introduction of find_by() method for Entities

• Introduction of save() method for Entities

• Support for Query Operators (>, >=, <, <=)

• Support for Conjunction Operators (AND, OR) in queries

• Change Fields to be full-fledged Descriptors to control getting/setting values

• Introduction of Support for References and Associations (HasOne and HasMany)

• Remove Pylint from static code analysis and use Flake8

0.0.7 (2019-01-16)

• Rename Repository to Adapter

• Rename Schema to Model

• Enhance Entity class to perform CRUD methods instead of relying on a separate Repo Factory

0.0.6 (2018-12-14)

• Repository rewritten from the ground up

• First base version for overall Protean functionality

0.0.5 (2018-07-21)

• Add Context Class

0.0.4 (2018-07-20)

• Add UseCase Utility Classes

• Add Repository Abstract Classes

0.0.3 (2018-07-20)

• Add bleach as a setup requirement

• Add GeoPoint and Decimal Data Types to Entities

0.0.2 (2018-07-19)

• Entity Base Class

0.0.1 (2018-07-15)

• First release on PyPI.