Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/AnyBlok/AnyBlok

AnyBlok is a Python framework for building business applications.
https://github.com/AnyBlok/AnyBlok

bloks development-tools framework sqlalchemy

Last synced: 3 months ago
JSON representation

AnyBlok is a Python framework for building business applications.

Awesome Lists containing this project

README 

        
.. This file is a part of the AnyBlok project

..

..    Copyright (C) 2014 Jean-Sebastien SUZANNE 

..    Copyright (C) 2019 Jean-Sebastien SUZANNE 

..    Copyright (C) 2019 Hugo QUEZADA 

..

.. This Source Code Form is subject to the terms of the Mozilla Public License,

.. v. 2.0. If a copy of the MPL was not distributed with this file,You can

.. obtain one at http://mozilla.org/MPL/2.0/.



.. image:: https://img.shields.io/pypi/pyversions/anyblok.svg?longCache=True

    :alt: Python versions



.. image:: https://img.shields.io/pypi/v/AnyBlok.svg

   :target: https://pypi.python.org/pypi/AnyBlok/

   :alt: Version status



.. image:: https://travis-ci.org/AnyBlok/AnyBlok.svg?branch=master

    :target: https://travis-ci.org/AnyBlok/AnyBlok

    :alt: Build status



.. image:: https://coveralls.io/repos/github/AnyBlok/AnyBlok/badge.svg?branch=master

    :target: https://coveralls.io/github/AnyBlok/AnyBlok?branch=master

    :alt: Coverage



.. image:: https://readthedocs.org/projects/anyblok/badge/?version=latest

    :alt: Documentation Status

    :scale: 100%

    :target: https://doc.anyblok.org/en/latest/?badge=latest



.. image:: https://badges.gitter.im/AnyBlok/community.svg

    :alt: gitter

    :target: https://gitter.im/AnyBlok/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge



.. image:: https://img.shields.io/static/v1?label=Compatible%20with&message=PostgreSQL%20|%20MySQL%20|%20Microsoft%20SQL%20Server&color=informational

    :alt: Dialects compatibility



AnyBlok

=======



AnyBlok is a Python framework allowing to create highly dynamic and modular

applications on top of SQLAlchemy.



AnyBlok is released under the terms of the `Mozilla Public License`.



AnyBlok is hosted on `github `_ - the main project

page is at https://github.com/anyblok/anyblok or

http://code.anyblok.org. source code is tracked here

using `git `_.



Releases and project status are available on Pypi at

https://pypi.python.org/pypi/anyblok.



The most recent published version of the documentation should be at

https://doc.anyblok.org.



There is a tutorial to teach you how to develop applications with AnyBlok at

https://anyblok.gitbooks.io/anyblok-book/content/en/



Project Status

--------------



AnyBlok is expected to be stable.

Some early partners are using it on production and are involved in

the project development.

We are aiming to make a stable release as soon as possible.



Users should take care to report bugs and missing features on an as-needed

basis.



It should be expected that the development version may be required

for proper implementation of recently repaired issues in between releases;

the latest master is always available at https://github.com/AnyBlok/AnyBlok/archive/master.zip.



Installation

------------



Install released versions of AnyBlok from the Python package index with

`pip `_ or a similar tool::



    pip install anyblok



Installation via source distribution is via the ``setup.py`` script::



    python setup.py install



Installation will add the ``anyblok`` commands to the environment.



Running Tests

-------------



To run framework tests with ``pytest``::



    pip install pytest

    ANYBLOK_DATABASE_DRIVER=postgresql ANYBLOK_DATABASE_NAME=test_anyblok py.test anyblok/tests



To run tests of all installed bloks with demo data::



    anyblok_createdb --db-name test_anyblok --db-driver-name postgresql --install-all-bloks --with-demo

    ANYBLOK_DATABASE_DRIVER=postgresql ANYBLOK_DATABASE_NAME=test_anyblok py.test anyblok/bloks



AnyBlok is tested continuously using `Travis CI

`_



Contributing (hackers needed!)

------------------------------



AnyBlok is ready for production usage even though it can be

improved and enriched.

Feel free to fork, talk with core dev, and spread the word !



Author

------



Jean-Sébastien Suzanne



Contributors

------------



* Jean-Sébastien Suzanne

* Georges Racinet

* Pierre Verkest

* Franck Bret

* Denis Viviès

* Alexis Tourneux

* Hugo Quezada

* Simon André

* Florent Jouatte

* Christophe Combelles

* Sébastien Chazallet

* François GUÉRIN



Bugs

----



Bugs and features enhancements to AnyBlok should be reported on the `Issue

tracker `_.