diff --git a/.gitignore b/.gitignore index d9970f7..35c3e89 100644 --- a/.gitignore +++ b/.gitignore @@ -5,3 +5,8 @@ build/ dist/ wayward.egg-info/ +.mypy_cache/ +.pytest_cache/ + +.dmypy.json +.python-version diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..b9c5741 --- /dev/null +++ b/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. diff --git a/README.rst b/README.rst index 53cfe26..809e63d 100644 --- a/README.rst +++ b/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 `_ +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 "] license = "LGPL-3.0"