Skip to content

Latest commit

 

History

History
139 lines (93 loc) · 4.72 KB

CHANGELOG.md

File metadata and controls

139 lines (93 loc) · 4.72 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 Semantic Versioning.

[1.3.1] - 2024-11-28

Changed

[1.3.0] - 2024-10-23

Added

  • Database versioning is now synced with the project version
  • Databases on old versions will now automatically migrate to the version of Effortless
  • New configuration applications will now fail to apply if their required fields or max_size do not match the current database
  • You can now use search() to filter for a single value
  • Keyed encryption has been implemented and is now required for encrypted databases
    • Pass in a key (password) into EffortlessDB() or use encrypt() to set the key
    • This will automatically configure the DB to be encrypted
    • To access the DB in the future, all EffortlessDB object must use that encryption key
    • You can automatically change the key for the database file with set_encryption_key
    • Use decrypt() to remove encryption
  • Implemented automatic migration for databases on versions less than current

Changed

  • EffortlessConfig now takes keyword parameters instead of a dictionary
    • Use from_dict if you need the old functionality

[1.2.0.1] - 2024-10-22

Added

  • Added Unix timestamp support to between_dates() conditions
  • Date conditions are now timezone-aware (UTC)
  • Fixed some typing issues

Docs

  • Added technical per-object documentation pages
  • Updated themes and visuals
  • Added a changelog page that reflects CHANGELOG.md

[1.2.0] - 2024-10-22

Added

  • Added the remove and erase methods to delete entries that pass conditions
  • Added the update and batch methods to update entries that pass conditions

Changed

  • Fixed an issue where a Field would not exist if the field's value was None
  • Migrated to use 'Entry' rather than 'Item' for clarity
  • Multiple entries are now returned in a list format rather than a dict format

Docs

  • Added a favicon to the documentation
  • Migrated to use 'Entry' rather than 'Item' for clarity
  • Fleshed out the Home, Quickstart, and Usages
  • Detailed per-method documentation & search coming soon!

Notes

  • 1.2.0 is not compatible with databases from 1.1.1 or below. We hope that this is the last minor update that is not backwards-compatible; expect an auto-migrate feature to come soon.

[1.1.1] - 2024-10-21

Added

  • Introduced new passes method for custom filtering functions
  • Added is_type method for type checking in queries
  • Implements a blocking finish_backup method to databases to complete a backup before proceeding

[1.1.0] - 2024-10-20

Added

  • Introduced new filter method to replace the previous search functionality
  • Added Query and Field classes for more powerful and flexible querying
  • Implemented a comprehensive set of query methods:
    • equals, contains, startswith, endswith
    • greater_than, less_than
    • matches_regex, between_dates, fuzzy_match
  • Introduced support for lambdas in Queries to give granular filtering power
  • Expanded test suite with extensive coverage for new features

Changed

  • Replaced search method with filter for more intuitive querying
  • Updated documentation to reflect new querying capabilities

Removed

  • Removed search method in favor of filter

[1.0.0] - 2024-10-19

Added

  • Fully-fledged configuration support has been implemented
    • Make an EffortlessConfig and configure your DB with it
    • Configurations like readonly, max_size, and required can be set to restrict your database
    • Encryption, compression, and backups can be set to secure your database (partially implemented)
  • More configuration has been automated (less effort for you!)
  • .effortless format has moved to header/content instead of numerical

Changed

  • Effortless database objects have been renamed to EffortlessDBs

Notes

  • 1.0.0 is not compatible with any previous versions of Effortless.

[0.1.0] - 2024-10-19

Added

  • Futureproofing for database configuration implementation
  • Support for filename and directory modification for Effortless files
  • Basic database manipulation functions: get_all(), search(), and add()
  • wipe() function to clear the database while keeping the file
  • Automatic database file creation if the specified db doesn't exist
  • Support for searching through list values in the search() method
  • Comprehensive testing suite for all functions and documentation
  • Simplified usage via from effortless import db

Changed

  • Updated README.md to reflect new features and capabilities