From a782977559ab32d240f0dbdea48122c16a6844ba Mon Sep 17 00:00:00 2001 From: Nicolas Hug Date: Mon, 2 Jan 2017 20:54:40 +0100 Subject: [PATCH] Version 1.0.1 Made it a scikit --- .gitignore | 3 ++- CHANGELOG.md | 6 ++++++ README.md | 7 ++++--- doc/source/index.rst | 16 ++++++++-------- setup.py | 11 +++++------ surprise/__init__.py | 2 +- 6 files changed, 26 insertions(+), 19 deletions(-) diff --git a/.gitignore b/.gitignore index 367ea8eb..a61522e2 100644 --- a/.gitignore +++ b/.gitignore @@ -6,7 +6,8 @@ doc/build .ipynb_checkpoints/ .cache/ -surprise.egg-info/ +scikit_surprise.egg-info/ + build dist/ surprise/similarities.c diff --git a/CHANGELOG.md b/CHANGELOG.md index 94f68554..7c352170 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,11 @@ Current ======= +VERSION 1.0.1 +============= + +Date: 02/01/17 + Enhancements ------------ @@ -16,6 +21,7 @@ Enhancements Other ----- +* Surprise is now a scikit! * Changed license to BSD * Six is now a dependency diff --git a/README.md b/README.md index c8cd9fcf..285f201a 100644 --- a/README.md +++ b/README.md @@ -13,8 +13,8 @@ Surprise Overview -------- -[Surprise](http://surpriselib.com) is an easy-to-use open source Python library -for recommender systems. +[Surprise](http://surpriselib.com) is an easy-to-use Python +[scikit](https://www.scipy.org/scikits.html) for recommender systems. [Surprise](http://surpriselib.com) **was designed with the following purposes in mind**: @@ -147,7 +147,8 @@ Installation / Usage The easiest way is to use pip (you'll need [numpy](http://www.numpy.org/)): - $ pip install surprise + $ pip install numpy + $ pip install scikit-surprise Or you can clone the repo and build the source (you'll need [Cython](http://cython.org/) and [numpy](http://www.numpy.org/)): diff --git a/doc/source/index.rst b/doc/source/index.rst index 02a2fadb..800fec56 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -8,14 +8,14 @@ Welcome to Surprise' documentation! =================================== -`Surprise `_ is an easy-to-use open source Python -library for recommender systems. - -If you're new to `Surprise `_, we -invite you to take a look at the :ref:`getting_started` guide, where you'll -find a series of tutorials illustrating all you can do with `Surprise -`_. For installation guidelines, please -refer to the `project page `_. +`Surprise `_ is an easy-to-use Python `scikit +`_ for recommender systems. + +If you're new to `Surprise `_, we invite you to take a +look at the :ref:`getting_started` guide, where you'll find a series of +tutorials illustrating all you can do with `Surprise +`_. For installation guidelines, please refer to the +`project page `_. Any kind of feedback/criticism would be greatly appreciated (software design, documentation, improvement ideas, spelling mistakes, etc...). Please feel free diff --git a/setup.py b/setup.py index 8d65e46a..3bc86b3b 100644 --- a/setup.py +++ b/setup.py @@ -15,7 +15,7 @@ else: USE_CYTHON = True -__version__ = '1.0.0' +__version__ = '1.0.1' here = path.abspath(path.dirname(__file__)) @@ -58,16 +58,15 @@ ext_modules = extensions setup( - name='surprise', + name='scikit-surprise', author='Nicolas Hug', author_email='contact@nicolas-hug.com', - description=('A recommender system package aimed towards researchers ' + - 'and students.'), + description=('An easy-to-use library for recommender systems.'), long_description=long_description, version=__version__, - url='https://nicolashug.github.io/Surprise/', + url='http://surpriselib.com', license='GPLv3+', classifiers=[ @@ -82,7 +81,7 @@ ], keywords='recommender recommendation system', - packages=find_packages(exclude=['docs', 'tests*']), + packages=find_packages(exclude=['tests*']), include_package_data=True, ext_modules = ext_modules, cmdclass=cmdclass, diff --git a/surprise/__init__.py b/surprise/__init__.py index d4e80320..15fed445 100644 --- a/surprise/__init__.py +++ b/surprise/__init__.py @@ -24,4 +24,4 @@ 'CoClustering', 'PredictionImpossible', 'Dataset', 'Reader', 'evaluate', 'dump'] -__version__ = get_distribution('surprise').version +__version__ = get_distribution('scikit-surprise').version