{
    "info": {
        "author": "Tran Ly Vu",
        "author_email": "vutransingapore@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 4 - Beta",
            "Environment :: Console",
            "Framework :: Pytest",
            "Intended Audience :: Developers",
            "Intended Audience :: End Users/Desktop",
            "Intended Audience :: Science/Research",
            "License :: OSI Approved :: Apache Software License",
            "Natural Language :: English",
            "Operating System :: POSIX",
            "Operating System :: POSIX :: Linux",
            "Operating System :: Unix",
            "Programming Language :: Python :: 2",
            "Programming Language :: Python :: 2.7",
            "Programming Language :: Python :: 3",
            "Programming Language :: Python :: 3.6",
            "Programming Language :: Python :: 3.7",
            "Programming Language :: Python :: Implementation :: CPython",
            "Programming Language :: Python :: Implementation :: PyPy",
            "Topic :: Education",
            "Topic :: Scientific/Engineering",
            "Topic :: Scientific/Engineering :: Artificial Intelligence",
            "Topic :: Scientific/Engineering :: Information Analysis"
        ],
        "description": "<p align=\"center\">\n\t<a href=\"https://github.com/tranlyvu/recommender\"><img src=\"https://github.com/tranlyvu/recommender/blob/dev/img/recommender_logo.png\" width=\"300\" height=\"300\"></a>\t\n</p>\n\n<p align=\"center\">\n\t<a href=\"https://pypi.org/project/recommender-engine/\"><img src=\"https://img.shields.io/pypi/v/recommender-engine.svg\"></a>\n\t<a href=\"https://pepy.tech/project/recommender-engine\"><img src=\"https://pepy.tech/badge/recommender-engine\"></a>\n\t<a href=\"http://hits.dwyl.io/tranlyvu/recommender\"><img src=\"http://hits.dwyl.io/tranlyvu/recommender.svg\"></a>\n\t<a href=\"https://github.com/tranlyvu/recommender\"><img src=\"http://githubbadges.com/star.svg?user=tranlyvu&repo=recommender&style=default\"></a>\n    <a href=\"https://github.com/tranlyvu/recommender/fork\"><img src=\"http://githubbadges.com/fork.svg?user=tranlyvu&repo=recommender&style=default\"></a>\n</p>\n\n---\n\nRecommender is a recommendation application using either item-based or user-based approaches.\n\nRecommender is at version [v0.3.0](https://github.com/tranlyvu/recommender/releases), also see [change log](https://github.com/tranlyvu/recommender/blob/dev/CHANGELOG.md) for more details on release history.\n\nIf you like this project, feel fee to leave a few words of appreciation here [![Say Thanks!](https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg)](https://saythanks.io/to/tranlyvu)\n\n| Build | [![Build Status][3]][4] | [![Coverage Status][5]][6] |\n| :--- | :--- | :---  |\n| **Quality** | [![Maintainability][13]][14] | [![Requirements Status][19]][20] |\n| **Support** | [![gitter][17]][18] |  |\n| **Platform** | [![pyversion][25]][26] | [![implementation][27]][28] |\n\n[3]: https://travis-ci.org/tranlyvu/recommender.svg?branch=dev\n[4]: https://travis-ci.org/tranlyvu/recommender\n[5]: https://coveralls.io/repos/github/tranlyvu/recommender/badge.svg?branch=dev\n[6]: https://coveralls.io/github/tranlyvu/recommender?branch=dev\n[13]: https://api.codeclimate.com/v1/badges/de05d6acb8cd3b11aa0c/maintainability\n[14]: https://codeclimate.com/github/tranlyvu/recommender/maintainability\n[19]: https://requires.io/github/tranlyvu/recommender/requirements.svg?branch=dev\n[20]: https://requires.io/github/tranlyvu/recommender/requirements/?branch=dev\n[17]: https://badges.gitter.im/gitterHQ/gitter.png\n[18]: https://gitter.im/recommender-engine\n[25]: https://img.shields.io/pypi/pyversions/recommender-engine.svg\n[26]: https://pypi.org/project/recommender-engine/\n[27]: https://img.shields.io/pypi/implementation/recommender-engine.svg\n[28]: https://pypi.org/project/recommender-engine/\n\n---\nTable of contents\n---\n\n1. [Usage](#Usage)\n2. [Contribution](#Contribution) \n4. [License](#License)\n\n---\nUsage\n---\n\nInstall with pip\n\n```\n$ pip install recommender-engine\n```\n\n### API\n\nmake_recommendation(person_to_recommend, preference_space, recommender_approach='user_based', number_of_items_to_recommend=10, similarity_measure='euclidean_distance')\n\n```\t\n\tReturn list of recommendation items based on the chosen approach and similarity emasure\n\n\tParameters\n\t--------------\n\tperson_to_recommend (str): user id/name to recommend to\n\n\tpreference_space (dict):  keys are user id/name and values are dictionary of items and ratings\n\n\trecommender_approach (str): support 'user_based' (default) or 'item_based'\n\n\tnumber_of_items_to_recommend (int): number of items to recommend (default=10)\n\n\tsimilarity_measure (str): similarity measurement method , support 'euclidean_distance' (default), 'cosine' or 'pearson_correlation'\n```\n\n### Example\n\n```\n\n>>> from recommender_engine import make_recommendation\n>>>\tresult = make_recommendation(person_to_recommend = \"userA\",\n\t\t\t\t\t\t\t\t preference_space = preference_space,\n\t\t\t\t\t\t\t\t recommender_approach = 'user_based',\n\t\t\t\t\t\t\t\t number_of_items_to_recommend = 10,\n\t\t\t\t\t\t\t\t similarity_measure = 'euclidean_distance')\n```\n\nThe preference space is dictionary data structure where keys are users and values are dictionary of items and ratings\n\n```\npreference_space = {\n\t\t\t\t\t'userA : {\n\t\t\t\t\t\t\t 'item1' : 'ratingA1, \n\t\t\t\t\t\t\t 'item2' : 'ratingA2',\n\t\t\t\t\t\t\t  ..., \n\t\t\t\t\t\t\t  'itemn' : 'ratingAn\n\t\t\t\t\t\t\t  }, \n\t\t\t\t\t..., \n\t\t\t\t\t'userZ:{\n\t\t\t\t\t\t\t'item1' : 'ratingZ1,\n\t\t\t\t\t\t\t 'item2' : 'ratingZ2',\n\t\t\t\t\t\t\t  ...,\n\t\t\t\t\t\t\t 'itemn' : 'ratingZn\n\t\t\t\t\t\t\t}\n\t\t\t\t    }\n```\n\n### Tested Datasets\n\nThe project has been tested on these Datasets\n\n1. [Jester](http://goldberg.berkeley.edu/jester-data)\n2. [MovieLens](http://files.grouplens.org/datasets/movielens/)\n\n---\nContribution [![Open Source Helpers][7]][8] \n---\n[7]: https://www.codetriage.com/tranlyvu/recommender/badges/users.svg\n[8]: https://www.codetriage.com/tranlyvu/recommender\n\nPlease follow our contribution convention at [contribution instruction](https://github.com/tranlyvu/recommender/blob/dev/CONTRIBUTING.md) and [code of conduct](https://github.com/tranlyvu/recommender/blob/dev/CODE-OF-CONDUCT.md)\n\nPlease check out the [issue file](https://github.com/tranlyvu/recommender/blob/dev/ISSUES.md) for list of issues that required helps.\n\n### Appreciation\n\nFeel free to add your name into the [list of contributors](https://github.com/tranlyvu/recommender/blob/dev/CONTRIBUTORS.md). You will automatically be inducted into Hall of Fame as a way to show my appreciation for your contributions\n\n#### Hall of Fame\n\n[![](https://sourcerer.io/fame/tranlyvu/tranlyvu/recommender/images/0)](https://sourcerer.io/fame/tranlyvu/tranlyvu/recommender/links/0)[![](https://sourcerer.io/fame/tranlyvu/tranlyvu/recommender/images/1)](https://sourcerer.io/fame/tranlyvu/tranlyvu/recommender/links/1)[![](https://sourcerer.io/fame/tranlyvu/tranlyvu/recommender/images/2)](https://sourcerer.io/fame/tranlyvu/tranlyvu/recommender/links/2)[![](https://sourcerer.io/fame/tranlyvu/tranlyvu/recommender/images/3)](https://sourcerer.io/fame/tranlyvu/tranlyvu/recommender/links/3)[![](https://sourcerer.io/fame/tranlyvu/tranlyvu/recommender/images/4)](https://sourcerer.io/fame/tranlyvu/tranlyvu/recommender/links/4)[![](https://sourcerer.io/fame/tranlyvu/tranlyvu/recommender/images/5)](https://sourcerer.io/fame/tranlyvu/tranlyvu/recommender/links/5)[![](https://sourcerer.io/fame/tranlyvu/tranlyvu/recommender/images/6)](https://sourcerer.io/fame/tranlyvu/tranlyvu/recommender/links/6)[![](https://sourcerer.io/fame/tranlyvu/tranlyvu/recommender/images/7)](https://sourcerer.io/fame/tranlyvu/tranlyvu/recommender/links/7)\n\n---\nLicense\n---\n\nSee the [LICENSE](https://github.com/tranlyvu/recommender/blob/master/LICENSE) file for license rights and limitations (Apache License 2.0).\n\n\n\n\n",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "https://github.com/tranlyvu/recommender/releases",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/tranlyvu/recommender",
        "keywords": "Recommender,Artificial Intelligence,Data Science",
        "license": "Apache License 2.0",
        "maintainer": "Tran Ly Vu <vutransingapore@gmail.com>",
        "maintainer_email": "vutransingapore@gmail.com",
        "name": "recommender-engine",
        "package_url": "https://pypi.org/project/recommender-engine/",
        "platform": "any",
        "project_url": "https://pypi.org/project/recommender-engine/",
        "project_urls": {
            "CI: Travis": "https://travis-ci.org/tranlyvu/recommender",
            "Chat: Gitter": "https://gitter.im/recommender/Lobby",
            "Coverage: coveralls": "https://coveralls.io/github/tranlyvu/recommender",
            "Download": "https://github.com/tranlyvu/recommender/releases",
            "Homepage": "https://github.com/tranlyvu/recommender",
            "Source": "https://github.com/tranlyvu/recommender",
            "Tracker": "https://github.com/tranlyvu/recommender/issues"
        },
        "release_url": "https://pypi.org/project/recommender-engine/0.3.0/",
        "requires_dist": null,
        "requires_python": ">=2.7, <4",
        "summary": "A recommendation application using either item-based or user-based approaches",
        "version": "0.3.0"
    },
    "last_serial": 5007592,
    "releases": {
        "0.3.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "0297c0cfc15ac9199a2e998ae82c5c52",
                    "sha256": "bf22156c73c01fc52d24f33ad6b6d49509a074c495d3fe90d56eef6f506f9080"
                },
                "downloads": -1,
                "filename": "recommender_engine-0.3.0-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "0297c0cfc15ac9199a2e998ae82c5c52",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": ">=2.7, <4",
                "size": 16423,
                "upload_time": "2019-03-30T17:20:08",
                "url": "https://files.pythonhosted.org/packages/be/6d/f4cab1427c9d6bfaac3e9798bede1a08b92307bc3c85ba1d4e9b55b2ab60/recommender_engine-0.3.0-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "d8c2ce56a85b6a4b4003bba437b09c99",
                    "sha256": "e4271662d44b56f3aa23a2a443ecb727d18a403329dd61c77e582e2262959f66"
                },
                "downloads": -1,
                "filename": "recommender-engine-0.3.0.tar.gz",
                "has_sig": false,
                "md5_digest": "d8c2ce56a85b6a4b4003bba437b09c99",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=2.7, <4",
                "size": 15453,
                "upload_time": "2019-03-30T17:20:09",
                "url": "https://files.pythonhosted.org/packages/fa/d0/373cacf3904a79599ce1126b794651c2f974221f59bcf97a5623716c8269/recommender-engine-0.3.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "0297c0cfc15ac9199a2e998ae82c5c52",
                "sha256": "bf22156c73c01fc52d24f33ad6b6d49509a074c495d3fe90d56eef6f506f9080"
            },
            "downloads": -1,
            "filename": "recommender_engine-0.3.0-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0297c0cfc15ac9199a2e998ae82c5c52",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=2.7, <4",
            "size": 16423,
            "upload_time": "2019-03-30T17:20:08",
            "url": "https://files.pythonhosted.org/packages/be/6d/f4cab1427c9d6bfaac3e9798bede1a08b92307bc3c85ba1d4e9b55b2ab60/recommender_engine-0.3.0-py2.py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "d8c2ce56a85b6a4b4003bba437b09c99",
                "sha256": "e4271662d44b56f3aa23a2a443ecb727d18a403329dd61c77e582e2262959f66"
            },
            "downloads": -1,
            "filename": "recommender-engine-0.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "d8c2ce56a85b6a4b4003bba437b09c99",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=2.7, <4",
            "size": 15453,
            "upload_time": "2019-03-30T17:20:09",
            "url": "https://files.pythonhosted.org/packages/fa/d0/373cacf3904a79599ce1126b794651c2f974221f59bcf97a5623716c8269/recommender-engine-0.3.0.tar.gz"
        }
    ]
}