Skip to content

CHANGELOG.md

Latest commit

 

History

History
85 lines (62 loc) · 4.47 KB

CHANGELOG.md

File metadata and controls

85 lines (62 loc) · 4.47 KB
Raw

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 PEP0440 styling guide. For full details, see the commit logs.

PEP0440 Styling Guide

Click to open PEP0440 Styilng Guide

Packaging for PyPI follows the standard PEP0440 styling guide and is implemented by the packaging.version.Version class. The other popular versioning scheme is semver, but each build has different parts/mapping. The following table gives a mapping between these two versioning schemes:

PyPI Version semver Version
epoch n/a
major major
minor minor
micro patch
pre prerelease
dev build
post n/a

One can use the packaging version to convert between PyPI to semver and vice-versa. For more information, check this link.

Release Note(s)

The release notes are documented, the list of changes to each different release are documented. The major.minor patch are indicated under h3 tags, while the micro and "version identifiers" are listed under h4 and subsequent headlines. The legend for changelogs are as follows:

  • 🎉 - Major Feature : something big that was not available before.
  • ✨ - Feature Enhancement : a miscellaneous minor improvement of an existing feature.
  • 🛠️ - Patch/Fix : something that previously didn’t work as documented – or according to reasonable expectations – should now work.
  • ⚙️ - Code Efficiency : an existing feature now may not require as much computation or memory.
  • 💣 - Code Refactoring : a breakable change often associated with major version bump.

Version 2.0.0 | WIP

The version is dedicated towards development and integration of fuzzy logic for sequence matching and scoring which can be used for classification, scoring and identification.

  • v2.0.0.a0 - Due to unplanned developmental changes, the version (v1+) is skipped and is maintained internally, while v2+ is the first proposed version for pblic usage. This version merges and is now assigned alpha release tag.

    • 💣 Fixes naming convention for the module (#15),
    • 💣 Remove redundant function _uniform_text_case() from the module, and
    • 🎉 Include advanced functionality like fuzzy scoring for text classification (#14).

  • v0.0.3.dev3 - Developmental preview release that allows the developer/end user to use the fuzzy module. The version is tagged internally as development release.

Version 1.0.0 | Conceptualization Phase | Internal, Not Released to Public

The conceptualization phase where the module objective, design patterns, and list of intended features for end-users are listed. The below versions are minor/micro changes related to the stable release.

  • v0.0.1.dev2 - Developmental Release, WIP

    • 🎉 Added more parametric control for text normalization like scentence case, strip line breaks.
    • 🛠️ Code compatibility with existing features to strip line breaks against strip characters commands.
    • ⚙️ All the different functionalities (like strip white space, etc.) are now moved under seperate private functions, this allows more control and easy management.

  • v0.0.1.dev1 - Developmental Release, 18.08.2024

    • 🛠️ Legacy GitHub Gist code is added under submodule nlpurify.legacy. For more details and migration techniques, check #5 for more informations.
    • 📝 Code documentation is hosted at RTD/nlpurify.
    • 🎉 Text normalization, i.e., cleaning of texts of unwanted characters like double space, multiple line breaks can now be cleaned by using function normalizeText().

  • v0.0.1.dev0 - Developmental Release, 17.08.2024

    • 🎉 Marks as the day when the ideation of the project started, and the name NLPurify is registered in PyPI.
    • ⚙️ This version is internal and have been deleted, this was released to block the package namespace.