Merge branch 'release/0.3.1'

.gitignore

@@ -5,3 +5,8 @@
 build/
 dist/
 wayward.egg-info/
+.mypy_cache/
+.pytest_cache/
+
+.dmypy.json
+.python-version

CHANGELOG.md

@@ -0,0 +1,54 @@
+# Changelog
+All notable changes to this project should be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.3.1] - 2019-06-05
+
+### Added
+
+- This changelog.
+
+### Changed
+
+- Explicitly specified the readme in `pyproject.toml`.
+- Updated install instructions for Poetry.
+
+
+## [0.3.0] - 2019-06-04
+
+### Added
+
+- Significant Words Language Model.
+- Pluggable specific terms estimator.
+- Tests for PLM document model.
+- Tests for SWLM model fit.
+- Tests for model (non-)equivalence between PLM and SWLM.
+- SWLM example in `exmaple/dickens.py`.
+- Usage examples in README.
+- Type hints in function annotations.
+
+### Changed
+
+- Renamed package to Wayward.
+- Replaced `setup.py` with `pyproject.toml`.
+- `ParsimoniousLM.top()` now returns linear probabilities instead of log-probabilities.
+
+### Removed
+
+- Dropped python 2.7 compatibility in favor of ^3.7.
+
+### Fixed
+
+- `KeyError` when out-of-vocabulary terms occurred in a document.
+
+## [0.2.x] - 2011-11-13 to 2013-04-18
+
+The WeighWords version from which Wayward was forked.
+
+Some commits have been put on the master branch after bumping the version to 0.2.
+Since there is no git tag to pin down what's part of 0.2, I've mentioned both the
+version bump date, and the date of the latest commit that we use here.

README.rst

@@ -1,3 +1,6 @@
+Wayward
+=======
+
 **Wayward** is a Python package that helps to identify characteristic terms from
 single documents or groups of documents. It can be used to create word clouds.
 
@@ -28,13 +31,12 @@ Either install the latest release from PyPI::
 
     pip install wayward
 
-or clone this git repository, and::
-
-    python setup.py install
-
-or::
+or clone the git repository, and use `Poetry <https://poetry.eustace.io/docs/>`_
+to install the package in editable mode::
 
-    pip install -e .
+    git clone https://github.com/aolieman/wayward.git
+    cd wayward/
+    poetry install
 
 Usage
 -----
@@ -93,11 +95,11 @@ This package started out as `WeighWords <https://github.com/larsmans/weighwords/
 written by Lars Buitinck at the University of Amsterdam. It provides an efficient
 parsimonious LM implementation, and a very accessible API.
 
-A recent innovation in parsimonious language modeling, Significant Words Language
+A recent innovation in language modeling, Significant Words Language
 Models, led to the addition of a two-way parsimonious language model to this package.
 This new version targets python 3.x, and after a long slumber deserved a fresh name.
 The name "Wayward" was chosen because it is a near-homophone of WeighWords, and as
-a wink to parsimonious language modeling: it uncovers which terms "depart" most from
+a nod to parsimonious language modeling: it uncovers which terms "depart" most from
 the background collection. The parsimonization algorithm discounts terms that are
 already well explained by the background model, until the most wayward terms come
 out on top.

pyproject.toml

@@ -1,7 +1,8 @@
 [tool.poetry]
 name = "wayward"
-version = "0.3.0"
+version = "0.3.1"
 repository = "https://github.com/aolieman/weighwords"
+readme = "README.rst"
 description = "Wayward is a Python package that helps to identify characteristic terms from single documents or groups of documents."
 authors = ["Alex Olieman <alex@olieman.net>"]
 license = "LGPL-3.0"