Contents
Front Matter¶
Information about the AnyBlok project.
Project Homepage¶
AnyBlok is hosted on github - the main project page is at http://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 http://pypi.python.org/pypi/anyblok.
The most recent published version of this documentation should be at http://doc.anyblok.org.
Project Status¶
AnyBlok is currently in alpha status and is expected to be fairly stable. 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.
Note
AnyBlok use Python version >= 3.4
Running Tests¶
To run framework tests with nose
:
pip install nose
nosetests anyblok/tests
To run tests of all installed bloks:
anyblok_nose -c config.file.cfg
To run Blok tests during their installation:
anyblok_updatedb -c config.file.cfg --install_bloks myblok --test-blok-at-install
AnyBlok is tested continuously using Travis CI
Dependencies¶
AnyBlok works with Python 3.4 and later. The install process will ensure that SQLAlchemy, Alembic, SQLAlchemy-Utils are installed, in addition to other dependencies.
AnyBlok works with SQLAlchemy from version 1.0.11, Alembic from version 0.8.4 and SQLAlchemy-Utils from version 0.31.4. The latest version of them is strongly recommended.
Contributing (hackers needed!)¶
Anyblok is at a very early stage, feel free to fork, talk with core dev, and spread the word!
Contributors¶
Anybox team:
- Georges Racinet
- Christophe Combelles
- Jean-Sébastien Suzanne
- Florent Jouatte
- Simon André
- Pierre Verkest
other:
- Sébastien Chazallet
- Franck Bret
Bugs¶
Bugs and feature enhancements to AnyBlok should be reported on the Issue tracker.