{
    "info": {
        "author": "CERN",
        "author_email": "cds.support@cern.ch",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 2 - Pre-Alpha",
            "Environment :: Web Environment",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: GNU General Public License v2 (GPLv2)",
            "Operating System :: OS Independent",
            "Programming Language :: Python",
            "Programming Language :: Python :: 2",
            "Programming Language :: Python :: 2.7",
            "Programming Language :: Python :: 3",
            "Programming Language :: Python :: 3.3",
            "Programming Language :: Python :: 3.4",
            "Programming Language :: Python :: 3.5",
            "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
            "Topic :: Software Development :: Libraries :: Python Modules"
        ],
        "description": "Record Recommender\n==================\n\n.. image:: https://travis-ci.org/CERNDocumentServer/record-recommender.svg?branch=master\n    :target: https://travis-ci.org/CERNDocumentServer/record-recommender\n\n\nThe Record Recommender creates recommendations for Invenio.\nBy reading page views and downloads from Elasticsearch calculating the\nrecommendations and storing them in Redis to be retrieve and displayed\nby Invenio.\n\n\nUsage\n-----\n\nThe workflow to generate the recommendations is:\n\n1. ``recommender fetch 24`` to cache the last 24 weeks of page views and downloads\n   from Elasticsearch.\n2. ``recommender profiles 24`` generate the user profiles from the page views\n   and downloads. For the not logged in users profiles based on the\n   ip-address and user agent are created.\n3. ``recommender build 50`` calculates the recommendations using 50 processes\n   and stores them in the specified Redis server.\n\nAlternative the recommendations can be automatically be fetched, the profiles\ngenerated and the recommendations calculated all this with one command:\n\n`recommender update_recommender 24 50` for the last 24 weeks and using\n50 processes.\n\n\n\nConfiguration\n-------------\nThe configuration file is expected to be in ``/etc/record_recommender.yml``\notherwise the path to the config file can be defined by using the\ncommand line option ``--config_path``.\n\n.. code-block:: yaml\n\n    # Record-Recommender configuration.\n\n    elasticsearch:\n    es_index: ['index-2014', 'index-2015', 'index-2016']\n    es_user: user\n    es_password:\n    es_host: localhost\n    es_port: 443\n\n    recommendation_version: 1\n\n    # Sentry connection string\n    sentry:\n\n    redis:\n    host: localhost\n    port: 6379\n    db: 0\n    prefix: 'Reco_1::'\n\n    cache:\n    base_path: cache/\n    cache_file_prefix: ''\n\n    logging:\n    version: 1\n    disable_existing_loggers: False\n    formatters:\n        simple:\n        format: '%(asctime)s - %(name)s - %(levelname)s - %(message)s'\n    handlers:\n        console:\n        class: logging.StreamHandler\n        level: INFO\n        formatter: simple\n        stream: ext://sys.stdout\n        sentry:\n        class: raven.handlers.logging.SentryHandler\n        level: WARN\n        dsn:\n        file:\n        class : logging.FileHandler\n        formatter: simple\n        level: DEBUG\n        filename: log_recommender.log\n    loggers:\n        record_recommender:\n        level: DEBUG\n        handlers: [console, file, sentry]\n        propagate: no\n        # elasticsearch:\n        #   level: WARN\n        #   handlers: [console]\n        #   propagate: no\n    root:\n        level: ERROR\n        handlers: [console, file, sentry]\n\nAdditional to the configuration options found in the config file\nenvironment variables, which overwrite the ones from the config file can be set.\n\n- ``RECOMMENDER_ES_PASSWORD`` to set the Elasticsearch password.\n- ``RECOMMENDER_SENTRY`` to set the Sentry connection string.\n\n\n\n\nCommand line\n------------\n\n.. code-block:: console\n\n    Usage: recommender [OPTIONS] COMMAND [ARGS]...\n\n    Record-Recommender command line version.\n\n    Options:\n    -v, --verbose           Enables verbose mode.\n    -c, --config_path TEXT  Path to the configuration file.\n    --help                  Show this message and exit.\n\n    Commands:\n    debug               Debug the application and recommender.\n    fetch               Fetch newest PageViews and Downloads.\n    build               Calculate all recommendations.\n    profiles            Number of weeks to build.\n    update_recommender  Download and build the recommendations.\n\n\nDebugging the Recommendations\n-----------------------------\nAs first step look into the created user profiles in the defined ``cache``\nfolder.\n\nTo explore the graph with all loaded data use the\n``recommender debug`` command to get a interactive python shell.",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/CERNDocumentServer/record-recommender",
        "keywords": "invenio recommendation",
        "license": "GPLv2",
        "maintainer": "",
        "maintainer_email": "",
        "name": "record-recommender",
        "package_url": "https://pypi.org/project/record-recommender/",
        "platform": "any",
        "project_url": "https://pypi.org/project/record-recommender/",
        "project_urls": {
            "Homepage": "https://github.com/CERNDocumentServer/record-recommender"
        },
        "release_url": "https://pypi.org/project/record-recommender/0.0.2/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "Record to Record Recommendations for Invenio.",
        "version": "0.0.2"
    },
    "last_serial": 3933997,
    "releases": {
        "0.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "6047ad6877365471cc0656480b3e1f91",
                    "sha256": "9613a148bd8cb4d6dd975697cba97e89879e09cff322f73c8b5c24b03fd52d93"
                },
                "downloads": -1,
                "filename": "record-recommender-0.0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "6047ad6877365471cc0656480b3e1f91",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 25423,
                "upload_time": "2016-05-12T08:23:59",
                "url": "https://files.pythonhosted.org/packages/ac/ab/f8cc3c840a7a8e4bc586140d9e619fc84e94dd79967c5c92429fdf276f86/record-recommender-0.0.1.tar.gz"
            }
        ],
        "0.0.1.dev20160000": [],
        "0.0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "a19dfdb81c00cb9d538ec06036a4dbd7",
                    "sha256": "cc9cf2131ec1ad3d5b0ab4a6acd6a9d7b9386b516b9886bfa7fb23eebfd57e1b"
                },
                "downloads": -1,
                "filename": "record-recommender-0.0.2.tar.gz",
                "has_sig": false,
                "md5_digest": "a19dfdb81c00cb9d538ec06036a4dbd7",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 25629,
                "upload_time": "2016-05-17T09:32:09",
                "url": "https://files.pythonhosted.org/packages/32/67/e09ad681936b1a4025c20854a5f6524f9d2f46a2e4f98ee63a87e9867228/record-recommender-0.0.2.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "a19dfdb81c00cb9d538ec06036a4dbd7",
                "sha256": "cc9cf2131ec1ad3d5b0ab4a6acd6a9d7b9386b516b9886bfa7fb23eebfd57e1b"
            },
            "downloads": -1,
            "filename": "record-recommender-0.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "a19dfdb81c00cb9d538ec06036a4dbd7",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 25629,
            "upload_time": "2016-05-17T09:32:09",
            "url": "https://files.pythonhosted.org/packages/32/67/e09ad681936b1a4025c20854a5f6524f9d2f46a2e4f98ee63a87e9867228/record-recommender-0.0.2.tar.gz"
        }
    ]
}