Architect
=========

.. image:: https://badge.fury.io/py/architect.svg
   :target: https://badge.fury.io/py/architect

.. image:: https://img.shields.io/travis/maxtepkeev/architect/master.svg
   :target: https://travis-ci.org/maxtepkeev/architect

.. image:: https://img.shields.io/coveralls/maxtepkeev/architect/master.svg
   :target: https://coveralls.io/r/maxtepkeev/architect?branch=master

Architect is a set of tools which enhances ORMs written in Python with more features and simplifies
different database related complex tasks.

Features
--------

* Supported ORMs

  - `Django <https://www.djangoproject.com>`_ >= 1.4
  - `Peewee <https://peewee.readthedocs.io>`_ >= 2.8.0
  - `Pony <https://ponyorm.com>`_ >= 0.5.0
  - `SQLAlchemy <https://www.sqlalchemy.org>`_ >= 1.0.0
  - `SQLObject <https://www.sqlobject.org>`_ >= 3.5.0

* Supported DBs

  - `PostgreSQL <https://www.postgresql.org>`_ >= 8.0
  - `MySQL <https://www.mysql.com>`_ >= 5.5

* Supports Python 2.7, 3.5 - 3.8
* Extensively documented

Dependencies
------------

Architect has no required external dependencies except for the ORM it will be used with.

Contacts and Support
--------------------

I will be glad to get your `feedback <https://github.com/maxtepkeev/architect/issues>`_, `pull requests
<https://github.com/maxtepkeev/architect/pulls>`_, `issues <https://github.com/maxtepkeev/architect/issues>`_,
whatever. Feel free to contact me for any questions.

Donations and Sponsorship
-------------------------

If you like this project and want to support it you have several options:

#. Just give this project a star at the `GitHub <https://github.com/maxtepkeev/architect>`_ repository.
#. Become a sponsor. Contact me via ``tepkeev at gmail dot com`` if you are interested in becoming a sponsor
   and we will discuss the terms and conditions.

Thanks
------

PremiumSoft for supporting this project by providing `Open Source License
<https://www.navicat.com/store/open-source>`_ of `Navicat <https://www.navicat.com>`_.

.. image:: _static/img/navicat_logo.png
   :width: 380px
   :height: 120px
   :target: https://www.navicat.com

Copyright and License
---------------------

Architect is licensed under Apache 2.0 license. Check the :doc:`license` for details.

Table of contents
-----------------

.. toctree::
   :includehidden:
   :maxdepth: 3

   installation
   features/index
   exceptions
   license
   changelog