.. This file is a part of the AnyBlok project .. .. Copyright (C) 2015 Jean-Sebastien SUZANNE .. .. 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/. .. AnyBlok documentation master file, created by sphinx-quickstart on Mon Feb 24 10:12:33 2014. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. .. contents:: 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.2** and later. The install process will ensure that `SQLAlchemy `_, `Alembic `_ are installed, in addition to other dependencies. AnyBlok will work with SQLAlchemy as of version **0.9.8**. AnyBlok will work with Alembic as of version **0.7.3**. 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 Bugs ---- Bugs and feature enhancements to AnyBlok should be reported on the `Issue tracker `_.