Front Matter

Information about the AnyBlok project.

Project Homepage

AnyBlok is hosted on Bitbucket - the main project page is at https://bitbucket.org/jssuzanne/anyblok or http://code.anyblok.org. Source code is tracked here using Mercurial.

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 beta 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 http://code.anyblok.org/get/default.tar.gz. or http://code.anyblok.org/get/default.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.

Unit Test

Run the framework test with nose:

pip install nose
nosetests anyblok/tests

Run all the installed bloks:

anyblok_nose -c config.file.cfg

Run the blok tests at the installation:

anyblok_updatedb -c config.file.cfg --install_bloks myblok --test-blok-at-install

AnyBlok are tested by the Anybox builbot

Dependencies

AnyBlok works with Python 3.3 and later. The install process will ensure that SQLAlchemy, Alembic, SQLAlchemy-Utils are installed, in addition to other dependencies. AnyBlok will work with SQLAlchemy as of version 1.0.11. AnyBlok will work with Alembic as of version 0.8.4. AnyBlok will work with SQLAlchemy-Utils as of 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!

Author

Jean-Sébastien Suzanne

Contributors

Anybox team:

  • Georges Racinet
  • Christophe Combelles
  • Sandrine Chaufournais
  • Jean-Sébastien Suzanne
  • Florent Jouatte
  • Simon André
  • Clovis Nzouendjou
  • Pierre Verkest
  • Franck Bret
  • Sébastien Morele

other:

  • Sébastien Chazallet

Bugs

Bugs and feature enhancements to AnyBlok should be reported on the Issue tracker.