{
    "info": {
        "author": "Solocal Group",
        "author_email": "eureka@solocal.com",
        "bugtrack_url": null,
        "classifiers": [],
        "description": "I Quick start\r\n=============\r\n\r\nI.1 Stackless Python installation\r\n---------------------------------\r\n\r\nEureka is a solution that requires a custom Python implementation called `Stackless Python`_ (version 2.7).\r\n\r\nIn order to install it via the sources, first ensure you have the prerequisite system dependencies :\r\n\r\n- For Debian based distributions::\r\n\r\n    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\r\n\r\nthen complete the following commands::\r\n\r\n    $ wget http://www.stackless.com/binaries/stackless-278-export.tar.bz2\r\n    $ tar xf stackless-278-export.tar.bz2\r\n    $ cd stackless-278-export\r\n    $ ./configure --prefix=<STACKLESS_DIR> && make -j3 all && make install\r\n\r\n.. _Stackless Python: http://www.stackless.com\r\n\r\nI.2 Virtualenv and setuptools install\r\n-------------------------------------\r\n\r\nIn 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::\r\n\r\n    $ wget https://bootstrap.pypa.io/ez_setup.py -O - | <STACKLESS_DIR>/bin/python\r\n    $ <STACKLESS_DIR>/bin/easy_install virtualenv\r\n\r\nNote: you can also find some more details on how to install Stackless Python on `its documentation`_\r\n\r\n.. _its documentation: http://www.stackless.com/wiki\r\n\r\nI.3 Eureka installation\r\n-----------------------\r\n\r\nYou can create your ``virtualenv`` by doing::\r\n\r\n    $ <STACKLESS_DIR>/bin/virtualenv <EUREKA_DIR>\r\n    $ cd <EUREKA_DIR>\r\n\r\nYou can finally install Eureka open with ``easy_install``::\r\n\r\n    $ ./bin/easy_install eureka-opensource\r\n\r\nOr download the `compressed archive from PyPI`_ or `from Github`_ and run::\r\n\r\n    $ ./bin/easy_install <archive>\r\n\r\n.. _compressed archive from PyPI: https://pypi.python.org/pypi/eureka-opensource\r\n.. _from Github: https://github.com/solocalgroup/eureka-opensource\r\n\r\nI.5 Database creation\r\n---------------------\r\n\r\nBy 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`_::\r\n\r\n    $ ./bin/nagare-admin create-db eureka\r\n\r\n.. _Nagare command: http://www.nagare.org/trac/wiki/NagareAdmin\r\n\r\nI.6 Standalone application startup\r\n----------------------------------\r\n\r\nNow that your application has been successfully set up, you can run it in standalone mode using the following command::\r\n\r\n    $ ./bin/nagare-admin serve eureka\r\n\r\nAnd Voil\u00e0, you can now access your Eureka by accessing http://127.0.0.1:8080 in your favourite browser.\r\n\r\nII Application configuration & customization\r\n============================================\r\n\r\nThis section covers the main areas you may want to customize within your Eureka instance.\r\n\r\nPlease note that the below changes are explained in the context of a fresh copy of the code that is not yet installed. If this is already the case, you can still apply these changes but the provided locations will be different. Indeed, please consider the result of the following command as being your ``<EUREKA_DIR>`` onwards or just re-install Eureka after any customization::\r\n\r\n    $ <EUREKA_DIR>/bin/python -c \"import pkg_resources; print pkg_resources.get_distribution('eureka-opensource').location\"\r\n\r\nII.1 Nagare related configuration\r\n---------------------------------\r\n\r\nAs Nagare is based upon the Nagare Framework, the default configuration for the application can be found in ``<EUREKA_DIR>/conf/eureka.cfg``.\r\n\r\nIn 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.\r\n\r\n.. _this page: http://www.nagare.org/trac/wiki/ApplicationConfiguration\r\n\r\nII.2 Eureka specific configuration & customization\r\n--------------------------------------------------\r\n\r\nIn order to customize your application, you can modify the configuration file available at ``<EUREKA_DIR>/conf/eureka.cfg`` and adapt it to your taste.\r\nThis `EUREKA_DIR` can be found using the following command::\r\n\r\n    $ <EUREKA_DIR>/bin/python -c \"import pkg_resources; print pkg_resources.get_distribution('eureka-opensource').location\"\r\n\r\nAmong the configurable aspects of Eureka can be found:\r\n\r\n* ``security``: Security configuration (cookies/password)\r\n* ``points``: Points weighting\r\n* ``mail``: E-mail/recipients\r\n* ``html``: Presentation related optimization\r\n* ``filesystem``: The data directory location\r\n* ``search_engine``: By default uses Whoosh, but can also support Solr\r\n* ``dashboard``: Configuration of satistics to be displayed on your dashboard\r\n\r\nDetailed explanations on the aforementioned sections can be found directly within the ``<EUREKA_DIR>/conf/eureka.cfg`` configuration file.\r\n\r\nIdea domains\r\n^^^^^^^^^^^^\r\n\r\nIn order to import custom idea domains, you can use the following commands::\r\n\r\n    $ cd <EUREKA_DIR>\r\n    $ ./bin/nagare-admin eureka batch <EUREKA_DIR>/eureka/batch/populate_domains -c <CSV_FILEPATH>\r\n\r\nThe CSV filepath to be given as an argument has to be formatted similarly to what you can see in ``<EUREKA_DIR>/data/fixtures/domains.csv``. Although automatically detected, the recommended delimiters for your CSV are the comma ``,`` or the semicolon ``;``.\r\n\r\nArticle topics\r\n^^^^^^^^^^^^^^\r\n\r\nIn order to import custom article topics, you can use the following commands::\r\n\r\n    $ cd <EUREKA_DIR>\r\n    $ ./bin/nagare-admin eureka batch <EUREKA_DIR>/eureka/batch/populate_article_topics -c <CSV_FILEPATH>\r\n\r\nThe CSV filepath to be given as an argument has to be formatted similarly to what you can see in ``<EUREKA_DIR>/data/fixtures/article_topics.csv``. Although automatically detected, the recommended delimiters for your CSV are the comma ``,`` or the semicolon ``;``.\r\n\r\nEvent based point weighting\r\n^^^^^^^^^^^^^^^^^^^^^^^^^^^\r\n\r\nIn order to customize the number of points awarded to a given user following the below events, you can override the default values by adding a ``[points]`` section within you configuration file and add the following entries:\r\n\r\n* ``first_connection``: Allocated upon first ever connection\r\n* ``first_connection_of_the_day``: Allocated upon first connection of the day\r\n* ``vote``: Allocated whenever voting. Limited to 3 times a day\r\n* ``add_comment``: Allocated whenever making a comment. Limited to twice a day\r\n* ``publish_idea``: Allocated once publishing an idea. Equally divided among every co-author\r\n* ``publish_challenge_first_idea``: Awarded to the author(s) publishing the first idea of a challenge. Also equally divided among every author\r\n* ``approval``: Awarded to the author(s) whenever its idea gets approved. Also equally divided among every author\r\n* ``change_avatar``: Given to a user everytime he changes his avatar\r\n* ``select_idea``: Awarded to the author(s) whenever its idea gets selected. Also equally divided among every author\r\n* ``send_project_idea``: ...\r\n* ``send_prototype_idea``: ...\r\n\r\nII.3 Customized translations\r\n----------------------------\r\n\r\nIn 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.\r\n\r\nBased on `Babel`_, you can compile these translation files using the following command::\r\n\r\n    $ <EUREKA_DIR>/bin/pybabel compile -d $EUREKA_DIR/data/locale\r\n\r\nIf you want further details on how to compile handle internationalization using `Babel`_, you can refer to `this Babel documentation`_.\r\n\r\n.. _Babel: http://babel.pocoo.org/\r\n.. _this Babel documentation: http://babel.pocoo.org/docs/\r\n\r\nUser status levels\r\n^^^^^^^^^^^^^^^^^^\r\n\r\nIn order to customize the labels for the different user levels, you can edit them in the ``message.po`` located within the following path for the ``<LANG>`` language::\r\n\r\n    ``<EUREKA_DIR>/data/locale/<LANG>/LC_MESSAGES/messages.po``\r\n\r\nTheir related message ID (i.e. ``msgid`` within the file) are:\r\n\r\n* ``status_level0`` which is by default translated as `Inactive` in english\r\n* ``status_level1`` which is by default translated as `Pioneer` in english\r\n* ``status_level2`` which is by default translated as `Explorer` in english\r\n* ``status_level3`` which is by default translated as `Discoverer` in english\r\n* ``status_level4`` which is by default translated as `Visionary` in english\r\n* ``status_level5`` which is by default translated as `Brilliant` in english\r\n\r\nPlease note that these translations will then need to be re-compiled using the aforementioned batch command in section I.3.\r\n\r\nIdea state labels\r\n^^^^^^^^^^^^^^^^^\r\nIf you want to customize the idea state labels, you do so by editing the ``<EUREKA_DIR>/data/locale/<LANG>/LC_MESSAGES/messages.po`` files by changing the message IDs (i.e. ``msgid``) ending with ``_STATE`` (e.g. ``PROTOTYPE_STATE``)\r\n\r\nPlease note that these translations will then need to be re-compiled using the aforementioned batch command in section I.3.\r\n\r\nII.3 Publisher configuration\r\n----------------------------\r\n\r\nIf you are interested in deploying Eureka into a production server, you can use the publishers supported by `Nagare`_ as described in the its `documentation`_.\r\n\r\nAmong the supported Web servers can be found:\r\n\r\n* `Nginx`_\r\n* `Apache Web Server`_\r\n* `Lighttpd`_\r\n\r\nThese web serve can serve your Eureka application via their FastCGI module.\r\n\r\nTo help you write your web server configuration, Nagare provides `create-rules command`_ that will generate the rules needed to serve your Eureka instance.\r\n\r\n.. _Nagare: http://www.nagare.org\r\n.. _documentation: http://www.nagare.org/trac/wiki/ApplicationDeployment\r\n.. _Nginx: http://nginx.org/\r\n.. _Apache Web Server: http://httpd.apache.org/\r\n.. _Lighttpd: http://www.lighttpd.net/\r\n.. _create-rules command: http://www.nagare.org/trac/wiki/NagareAdmin\r\n\r\nIII Contribute\r\n==============\r\n\r\nIII.1 Development mode\r\n----------------------\r\n\r\nIn order to install Eureka in development mode, you can simply type::\r\n\r\n    $ <EUREKA_DIR>/bin/easy_install --editable --build-directory <EUREKA_DIR> eureka-opensource\r\n\r\nIII.2 Contributing\r\n------------------\r\n\r\nContributions 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`_.\r\n\r\nSo do not hesitate to fork the main repository and make pull requests!\r\n\r\n.. _our Github repository: https://github.com/solocalgroup/eureka-opensource\r\n.. _the Bitbucket one: https://bitbucket.org/solocalgroup/eureka-opensource\r\n\r\nIII.3 Coding style\r\n------------------\r\n\r\nUse PEP-8 as a coding standard. Ignored PEP8 errors can be found in the ``setup.cfg`` file within the ``[pep8]`` section.\r\n\r\nIII.4 Testing\r\n-------------\r\n\r\nContributions covered by tests are encouraged to help us raise the stability of Eureka.\r\n\r\nWe use `nose`_ to run our tests.\r\n\r\n.. _nose: https://nose.readthedocs.org/en/latest/",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "UNKNOWN",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://eureka-opensource.solocalgroup.com",
        "keywords": "innovation,web,application",
        "license": "CeCILL",
        "maintainer": "",
        "maintainer_email": "",
        "name": "eureka-opensource",
        "package_url": "https://pypi.org/project/eureka-opensource/",
        "platform": "UNKNOWN",
        "project_url": "https://pypi.org/project/eureka-opensource/",
        "project_urls": {
            "Download": "UNKNOWN",
            "Homepage": "https://eureka-opensource.solocalgroup.com"
        },
        "release_url": "https://pypi.org/project/eureka-opensource/1.0.3/",
        "requires_dist": null,
        "requires_python": null,
        "summary": "Innovative think tank web application",
        "version": "1.0.3"
    },
    "last_serial": 1788013,
    "releases": {
        "1.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "d05853b38b2312511ba82d5889f49008",
                    "sha256": "ecf7ff2d5044ec85f4ff183ef2d2d29b42e69da2f5d5d40bbc9de41c2f0ea9b3"
                },
                "downloads": -1,
                "filename": "eureka-opensource-1.0.1.zip",
                "has_sig": false,
                "md5_digest": "d05853b38b2312511ba82d5889f49008",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 16205469,
                "upload_time": "2015-09-23T13:44:08",
                "url": "https://files.pythonhosted.org/packages/f9/21/436e5a41a160c76fbe9e80ab66b56ad3f119480bc699d9844aa87fbeef31/eureka-opensource-1.0.1.zip"
            }
        ],
        "1.0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "98ff3cfd9697eb43fb7f564cb25708bf",
                    "sha256": "7ce628638e6b67e11f33e499c34ca28f7add03dfec78073775000b90aa93f26e"
                },
                "downloads": -1,
                "filename": "eureka-opensource-1.0.2.tar.gz",
                "has_sig": false,
                "md5_digest": "98ff3cfd9697eb43fb7f564cb25708bf",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 14967947,
                "upload_time": "2015-10-23T14:35:00",
                "url": "https://files.pythonhosted.org/packages/ab/8e/47ca3ced2a79d73b7aa6f9b12b787a6a117b6beb607694f36f0447e2a7d1/eureka-opensource-1.0.2.tar.gz"
            }
        ],
        "1.0.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "73221b2bb0b9628f061672c707ad5711",
                    "sha256": "788ff93e1e1a3a2ce572187ab553dc96477d02a8ae5c28302ee6f4e965383bfc"
                },
                "downloads": -1,
                "filename": "eureka-opensource-1.0.3.tar.gz",
                "has_sig": false,
                "md5_digest": "73221b2bb0b9628f061672c707ad5711",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 14968227,
                "upload_time": "2015-10-26T16:45:42",
                "url": "https://files.pythonhosted.org/packages/40/33/62e0c211f1c284d399d25b2ab6f41b27cd8df16a29639c9601e01e9f15a8/eureka-opensource-1.0.3.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "73221b2bb0b9628f061672c707ad5711",
                "sha256": "788ff93e1e1a3a2ce572187ab553dc96477d02a8ae5c28302ee6f4e965383bfc"
            },
            "downloads": -1,
            "filename": "eureka-opensource-1.0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "73221b2bb0b9628f061672c707ad5711",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 14968227,
            "upload_time": "2015-10-26T16:45:42",
            "url": "https://files.pythonhosted.org/packages/40/33/62e0c211f1c284d399d25b2ab6f41b27cd8df16a29639c9601e01e9f15a8/eureka-opensource-1.0.3.tar.gz"
        }
    ]
}