51 lines (41 loc) · 1.96 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

You should also add project tags for each release in Github, see Managing releases in a repository.

[Unreleased]

[2.1.0] - 2025-06-09

Changed

GitHub workflow for linting and formatting uses ruff as a separate job

Fixed

Fixed bug where only every other file was read instead of all files
Fixed Logging bug in add_tokenize_docs in word_count.py

Added

Added note for Z shell users to use quotes when running pip install -e .'[test,dev]'

Removed

GitHub action to run flake8 for linting in build
Removed wildcard from corpus-counter script dependency

[2.0.0] - 2024-05-29

Added

Added example auto-built Sphinx documentation in the docs folder
Github workflow for running ruff linter
A note about conda dependencies to README
A note about using docker containers to README
Ruff as a linter for development

Changed

All build and packaging switched to use only pyproject.toml
Minimum python version changed to 3.10
Github workflow checks python versions 3.10, 3.11, 3.12
Updated DVC version to avoid ImportError: cannot import name 'fsspec_loop' in older versions

Removed

Removed setup.cfg

[1.0.0] - 2022-05-23

Added

README and CHANGELOG
cdstemplate packages for computing word count from input text
corpus_counter_script.py as a user-facing script with argparse examples
Tests of cdstemplate packages
A github workflow to trigger tests on pull request to the main branch
Sample text data from Project Gutenberg
Data Version Control stage for the corpus_counter_script.py
A sample Jupyter notebook that plots most frequent words the Gutenberg data