Version 1.0.1

Made it a scikit

.gitignore

@@ -6,7 +6,8 @@ doc/build
 .ipynb_checkpoints/
 .cache/
 
-surprise.egg-info/
+scikit_surprise.egg-info/
+
 build
 dist/
 surprise/similarities.c

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
 

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/)):

doc/source/index.rst

@@ -8,14 +8,14 @@
 Welcome to Surprise' documentation!
 ===================================
 
-`Surprise <http://surpriselib.com>`_  is an easy-to-use open source Python
-library for recommender systems.
-
-If you're new to `Surprise <http://surpriselib.com>`_, 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
-<http://surpriselib.com>`_. For installation guidelines, please
-refer to the `project page <http://surpriselib.com>`_.
+`Surprise <http://surpriselib.com>`_  is an easy-to-use Python `scikit
+<https://www.scipy.org/scikits.html>`_ for recommender systems.
+
+If you're new to `Surprise <http://surpriselib.com>`_, 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
+<http://surpriselib.com>`_. For installation guidelines, please refer to the
+`project page <http://surpriselib.com>`_.
 
 Any kind of feedback/criticism would be greatly appreciated (software design,
 documentation, improvement ideas, spelling mistakes, etc...). Please feel free

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='[email protected]',
 
-    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,

surprise/__init__.py

@@ -24,4 +24,4 @@
            'CoClustering', 'PredictionImpossible', 'Dataset', 'Reader',
            'evaluate', 'dump']
 
-__version__ = get_distribution('surprise').version
+__version__ = get_distribution('scikit-surprise').version