Release version 0.3.3. (#146)

anhaidgroup · Oct 30, 2020 · a3bdb35 · a3bdb35
1 parent 9e76865
commit a3bdb35
Show file tree

Hide file tree

Showing 9 changed files with 71 additions and 54 deletions.
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -0,0 +1,6 @@
+v0.3.3 - 10/19/2020
+  * Started tracking release changes in CHANGES.txt.
+  * Minorly updated usage of Pandas to prevent a dependency on downgraded versions.
+  * Added stricter scikit-learn dependency requirements to preserve old Imputer API; will change in future release.
+  * Users can now provide metadata for blackbox features (ex. left_attribute, right_attribute, etc.).
+  * This is the last version of py_entitymatching that will support Python 2 and Python 3.5.
diff --git a/README.rst b/README.rst
@@ -22,23 +22,26 @@ Important links
 
 * Project Homepage: https://sites.google.com/site/anhaidgroup/projects/magellan/py_entitymatching
 * Code repository: https://github.com/anhaidgroup/py_entitymatching
+* User Manual: http://anhaidgroup.github.io/py_entitymatching/v0.3.3/index.html
+* Guides: http://anhaidgroup.github.io/py_entitymatching/v0.3.3/user_manual/guides.html
+* How to Contribute: http://anhaidgroup.github.io/py_entitymatching/v0.3.3/contributing.html
 * Issue Tracker: https://github.com/anhaidgroup/py_entitymatching/issues
 
 Dependencies
 ============
 
 The required dependencies to build the packages are:
 
-* pandas (provides data structures to store and manage tables). Tested on version 0.23.2.
-* scikit-learn (provides implementations for common machine learning algorithms). Tested on version 0.18.0.
-* joblib (provides multiprocessing capabilities). Tested on version 0.12.0.
-* pyqt5 (provides tools to build GUIs). Tested on version 5.6.0.
-* py_stringsimjoin (provides implementations for string similarity joins). Tested on version 0.3.0.
-* py_stringmatching (provides a set of string tokenizers and string similarity functions). Tested on version 0.4.0.
-* cloudpickle (provides functions to serialize Python constructs). Tested on version 0.2.1.
-* pyprind (library to display progress indicators). Tested on version 2.10.0.
-* pyparsing (library to parse strings). Tested on version 2.2.0.
-* six (provides functions to write compatible code across Python 2 and 3). Tested on version 2.11.0.
+* numpy 1.7.0 or higher; if using Python 2, numpy < 1.17; if using Python 3.5, numpy < 1.19. Tested on version 1.16.2.
+* pandas (provides data structures to store and manage tables). Tested on version 1.1.3.
+* scikit-learn (provides implementations for common machine learning algorithms); ≥ 0.18, < 0.22. Tested on version 0.20.0.
+* joblib (provides multiprocessing capabilities). Tested on version 1.17.0.
+* py_stringsimjoin (provides implementations for string similarity joins). Tested on version 0.3.2.
+* py_stringmatching (provides a set of string tokenizers and string similarity functions). Tested on version 0.4.2.
+* cloudpickle (provides functions to serialize Python constructs). Tested on version 1.6.0.
+* pyprind (library to display progress indicators). Tested on version 2.9.8.
+* pyparsing (library to parse strings). Tested on version 2.4.7.
+* six (provides functions to write compatible code across Python 2 and 3). Tested on version 1.15.0.
 
 Platforms
 =========

diff --git a/docs/conf.py b/docs/conf.py
@@ -15,7 +15,6 @@
 
 import sys
 import os
-import shlex
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -30,31 +29,31 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon'
-              # 'sphinx.ext.doctest',
-              # 'sphinx.ext.intersphinx',
-              # 'sphinx.ext.mathjax',
-              # 'sphinx.ext.ifconfig',
-              # 'sphinx.ext.viewcode',
-              # 'IPython.sphinxext.ipython_console_highlighting',
-              # 'IPython.sphinxext.ipython_directive'
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon',
+              'sphinx.ext.doctest',
+              'sphinx.ext.intersphinx',
+              'sphinx.ext.mathjax',
+              'sphinx.ext.ifconfig',
+              'sphinx.ext.viewcode',
+              'IPython.sphinxext.ipython_console_highlighting',
+              'IPython.sphinxext.ipython_directive'
               ]
-extensions += ['sphinxjp.themes.basicstrap']
+# extensions += ['sphinxjp.themes.basicstrap']
 
 # Napoleon settings
 napoleon_google_docstring = True
-# napoleon_numpy_docstring = True
-# napoleon_include_private_with_doc = False
-# napoleon_include_special_with_doc = True
-# napoleon_use_admonition_for_examples = False
-# napoleon_use_admonition_for_notes = False
-# napoleon_use_admonition_for_references = False
-# napoleon_use_ivar = False
-# # napoleon_use_param = True
-# napoleon_use_rtype = True
+napoleon_numpy_docstring = True
+napoleon_include_private_with_doc = False
+napoleon_include_special_with_doc = True
+napoleon_use_admonition_for_examples = False
+napoleon_use_admonition_for_notes = False
+napoleon_use_admonition_for_references = False
+napoleon_use_ivar = False
+napoleon_use_param = True
+napoleon_use_rtype = True
 
 # Add any paths that contain templates here, relative to this directory.
-#templates_path = ['_templates']
+templates_path = ['_templates']
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
@@ -77,9 +76,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.3.2'
+version = '0.3'
 # The full version, including alpha/beta/rc tags.
-release = '0.3.2'
+release = '0.3.3'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -130,8 +129,8 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'nature_with_gtoc'
-#html_theme = 'sphinx_rtd_theme'
+# html_theme = 'nature_with_gtoc'
+html_theme = 'sphinx_rtd_theme'
 # html_theme = 'nature'
 # html_theme = 'basicstrap'
 
@@ -147,7 +146,7 @@
 # html_theme_options = {'sidebarwidth': 360}
 
 # Add any paths that contain custom themes here, relative to this directory.
-html_theme_path = ['themes']
+# html_theme_path = ['themes']
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
@@ -168,7 +167,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-#html_static_path = ['_static']
+html_static_path = ['_static']
 
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied

diff --git a/docs/contributing.rst b/docs/contributing.rst
@@ -255,7 +255,7 @@ have ``sphinx`` and ``ipython`` installed.
 
 It is easiest to :ref:`create a development environment <contributing.dev_env>`, then install::
 
-      conda install -n py_entitymatching_dev sphinx ipython
+      conda install -n py_entitymatching_dev sphinx sphinx_rtd_theme ipython
 
 Building the documentation
 ~~~~~~~~~~~~~~~~~~~~~~~~~~

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,10 +1,8 @@
 
 User Manual for py_entitymatching
 =================================
-This document explains how to install and use the package.
-To contribute to the package, see the
-`project website <https://sites.google.com/site/anhaidgroup/projects/py_entitymatching>`_,
-section "For Contributors and Developers".
+
+This document explains how to install, use, and contribute to the package.
 
 Contents
 ========
@@ -27,17 +25,18 @@ Contents
     user_manual/steps_supp_em_workflows
     user_manual/misc
 
-
-
 .. toctree::
     :maxdepth: 3
     :caption: API Reference
 
     user_manual/api/overview
     user_manual/api/actual_commands
 
-
-
+.. toctree::
+    :maxdepth: 3
+    :caption: How to Contribute
+
+    contributing
 
 Indices and tables
 ==================

diff --git a/docs/user_manual/installation.rst b/docs/user_manual/installation.rst
@@ -4,12 +4,12 @@ Installation
 
 Requirements
 ------------
-* Python 2.7 or Python 3.5+
+* Python 2.7, 3.5, 3.6, or 3.7
 
 Platforms
 ---------
-py_entitymatching has been tested on Linux (Redhat enterprise Linux with 2.6
-.32 kernel), OS X (Sierra), and Windows 10.
+py_entitymatching has been tested on Linux (Ubuntu Xenial 16.04.6), macOS (High Sierra 10.13.6),
+and Windows 10.
 
 Dependencies
 ------------
@@ -30,6 +30,13 @@ Dependencies
 * ipython (provides better tools for displaying tables in notebooks)
 * scipy (dependency for skikit-learn)
 
+See the `project README <https://github.com/anhaidgroup/py_entitymatching/blob/master/README.rst>`
+for more information.
+
+.. note::
+
+    If using Python 2, py_entitymatching requires numpy less than 1.17; if using Python 3.5, numpy less than 1.19
+
 C Compiler Required
 -------------------
 Installing Using conda

diff --git a/docs/user_manual/whatisnew.rst b/docs/user_manual/whatisnew.rst
@@ -1,6 +1,9 @@
 What is New?
 ============
 
-Compared to Version 0.3.1, the followings are new:
- * Cython version was updated. The package is now built with updated Cython version >= 0.27.3.
- * Added support for Python 3.7 version and dropped Testing support for Python 3.4 version.
+Compared to Version 0.3.2, the followings are new:
+  * Started tracking release changes in CHANGES.txt.
+  * Minorly updated usage of Pandas to prevent a dependency on downgraded versions.
+  * Added stricter scikit-learn dependency requirements to preserve old Imputer API; will change in future release.
+  * Users can now provide metadata for blackbox features (ex. left_attribute, right_attribute, etc.).
+  * This is the last version of py_entitymatching that will support Python 2 and Python 3.5.
diff --git a/py_entitymatching/__init__.py b/py_entitymatching/__init__.py
@@ -1,7 +1,7 @@
 
 from py_entitymatching.catalog.catalog import Catalog
 
-__version__ = '0.3.2'
+__version__ = '0.3.3'
 
 _catalog = Catalog.Instance()
 

diff --git a/setup.py b/setup.py
@@ -82,7 +82,7 @@ def generate_cython():
                  ]
     setuptools.setup(
         name='py_entitymatching',
-        version='0.3.2',
+        version='0.3.3',
         description='Python library for end to end Entity Matching.',
         long_description=LONG_DESCRIPTION,
         url='https://sites.google.com/site/anhaidgroup/projects/magellan/py_entitymatching',
@@ -123,7 +123,7 @@ def generate_cython():
             'pyparsing >= 2.1.4',
             'scikit-learn >= 0.18,<0.22',
             'scipy',
-            'numpy==1.16.2'
+            'numpy'
         ],
         ext_modules=extensions,
         cmdclass=cmdclass,