Metadata-Version: 2.1
Name: protean
Version: 0.0.9
Summary: Protean Application Framework
Home-page: https://github.com/proteanhq/protean
Author: Subhash Bhushan C
Author-email: subhash@team8solutions.com
License: BSD 3-Clause License
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: Unix
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: OS/2
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: click (==7.0)
Requires-Dist: python-dateutil (==2.7.3)

********************************************************
Protean: The Clean Architecture, MultiPurpose Framework
********************************************************

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

.. image:: https://readthedocs.org/projects/protean/badge/?style=flat
    :target: https://readthedocs.org/projects/protean
.. image:: https://img.shields.io/pypi/l/protean.svg
    :target: https://pypi.org/project/protean/
.. image:: https://img.shields.io/pypi/v/protean.svg
    :target: https://pypi.org/project/protean/
.. image:: https://img.shields.io/pypi/wheel/protean.svg
    :target: https://pypi.org/project/protean/
.. image:: https://img.shields.io/pypi/pyversions/protean.svg
    :target: https://pypi.org/project/protean/
.. image:: https://img.shields.io/pypi/implementation/protean.svg
    :target: https://pypi.org/project/protean/
.. image:: https://codecov.io/gh/proteanhq/protean/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/proteanhq/protean

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).


Changelog
=========

0.0.1 (2018-07-15)
------------------

* First release on PyPI.

0.0.2 (2018-07-19)
------------------

* Entity Base Class

0.0.3 (2018-07-20)
------------------

* Add `bleach` as a setup requirement
* Add GeoPoint and Decimal Data Types to Entities

0.0.4 (2018-07-20)
------------------

* Add UseCase Utility Classes
* Add Repository Abstract Classes

0.0.5 (2018-07-21)
------------------

* Add Context Class

0.0.6 (2018-12-14)
------------------

* Repository rewritten from the ground up
* First base version for overall Protean functionality

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.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


