eureka-opensource 1.0.3

I.1 Stackless Python installation

Eureka is a solution that requires a custom Python implementation called Stackless Python (version 2.7).

In order to install it via the sources, first ensure you have the prerequisite system dependencies :

• For Debian based distributions:

  sudo apt-get install --no-install-recommends autoconf automake bzip2 ca-certificates file g++ gawk gcc libbz2-dev libffi-dev libfreetype6-dev libgdbm-dev libjpeg-dev libncurses-dev libopenjpeg-dev libpng-dev libpq-dev libreadline-dev libsqlite3-dev libssl-dev libtiff-dev libtool libwebp-dev libxml2-dev libxslt-dev make patch pkg-config wget xz-utils zlib1g-dev

then complete the following commands:

$ wget http://www.stackless.com/binaries/stackless-278-export.tar.bz2
$ tar xf stackless-278-export.tar.bz2
$ cd stackless-278-export
$ ./configure --prefix=<STACKLESS_DIR> && make -j3 all && make install

I.2 Virtualenv and setuptools install

In order to isolate your Eureka project, you can install and use virtualenv. To do so within you fresh Stackless Python, you can execute the following commands:

$ wget https://bootstrap.pypa.io/ez_setup.py -O - | <STACKLESS_DIR>/bin/python
$ <STACKLESS_DIR>/bin/easy_install virtualenv

Note: you can also find some more details on how to install Stackless Python on its documentation

I.3 Eureka installation

You can create your virtualenv by doing:

$ <STACKLESS_DIR>/bin/virtualenv <EUREKA_DIR>
$ cd <EUREKA_DIR>

You can finally install Eureka open with easy_install:

$ ./bin/easy_install eureka-opensource

Or download the compressed archive from PyPI or from Github and run:

$ ./bin/easy_install <archive>

I.5 Database creation

By default, Eureka is using a standard SQLite database for its persistence. So to create the database and its schema, you can use the following Nagare command:

$ ./bin/nagare-admin create-db eureka

I.6 Standalone application startup

Now that your application has been successfully set up, you can run it in standalone mode using the following command:

$ ./bin/nagare-admin serve eureka

And Voilà, you can now access your Eureka by accessing http://127.0.0.1:8080 in your favourite browser.

II.1 Nagare related configuration

As Nagare is based upon the Nagare Framework, the default configuration for the application can be found in <EUREKA_DIR>/conf/eureka.cfg.

In order to understand how to customize non domain specific parameters such as some basic application settings or the type of database to use, you can refer to this page to find the needed information.

II.2 Eureka specific configuration & customization

In order to customize your application, you can modify the configuration file available at <EUREKA_DIR>/conf/eureka.cfg and adapt it to your taste. This EUREKA_DIR can be found using the following command:

$ <EUREKA_DIR>/bin/python -c "import pkg_resources; print pkg_resources.get_distribution('eureka-opensource').location"

Among the configurable aspects of Eureka can be found:

• security: Security configuration (cookies/password)

• points: Points weighting

• mail: E-mail/recipients

• html: Presentation related optimization

• filesystem: The data directory location

• search_engine: By default uses Whoosh, but can also support Solr

• dashboard: Configuration of satistics to be displayed on your dashboard

Detailed explanations on the aforementioned sections can be found directly within the <EUREKA_DIR>/conf/eureka.cfg configuration file.

$ cd <EUREKA_DIR>
$ ./bin/nagare-admin eureka batch <EUREKA_DIR>/eureka/batch/populate_domains -c <CSV_FILEPATH>

$ cd <EUREKA_DIR>
$ ./bin/nagare-admin eureka batch <EUREKA_DIR>/eureka/batch/populate_article_topics -c <CSV_FILEPATH>

II.3 Customized translations

In order to internationalize your Eureka you may want to change the default translations. The translations files, located within the data/locale folder (with *.po extensions) of the project have to be compiled after any modification.

Based on Babel, you can compile these translation files using the following command:

$ <EUREKA_DIR>/bin/pybabel compile -d $EUREKA_DIR/data/locale

If you want further details on how to compile handle internationalization using Babel, you can refer to this Babel documentation.

``<EUREKA_DIR>/data/locale/<LANG>/LC_MESSAGES/messages.po``

II.3 Publisher configuration

If you are interested in deploying Eureka into a production server, you can use the publishers supported by Nagare as described in the its documentation.

Among the supported Web servers can be found:

• Nginx

• Apache Web Server

• Lighttpd

These web serve can serve your Eureka application via their FastCGI module.

To help you write your web server configuration, Nagare provides create-rules command that will generate the rules needed to serve your Eureka instance.

III.1 Development mode

In order to install Eureka in development mode, you can simply type:

$ <EUREKA_DIR>/bin/easy_install --editable --build-directory <EUREKA_DIR> eureka-opensource

III.2 Contributing

Contributions in the form of pull requests are always welcome. To do so, these can be done through either via our Github repository or the Bitbucket one.

So do not hesitate to fork the main repository and make pull requests!

III.3 Coding style

Use PEP-8 as a coding standard. Ignored PEP8 errors can be found in the setup.cfg file within the [pep8] section.

III.4 Testing

Contributions covered by tests are encouraged to help us raise the stability of Eureka.

We use nose to run our tests.