Skip to content

Latest commit

 

History

History
83 lines (65 loc) · 3.17 KB

CHANGELOG.md

File metadata and controls

83 lines (65 loc) · 3.17 KB
Raw

Changelog

The format is inspired by Keep a Changelog.

To Do

  • Django fields
  • docs/integrations: django fields
  • docs/internals
  • improve repr
  • logging
  • CI & version compatibility badges

Unreleased

0.4.0 - 2023-10-13

  • changed all_cname from classproperty to classmethod and add filter keyword
  • added filter keyword to all_dict and all_tuple
  • renamed all_cname to as_cnames, all_dict to as_dicts, and all_tuple to as_tuples
  • added pick and choices class methods
  • added getattr_inclusive instance method (supports "cname_pretty" and "ordinal" as if they were attributes)
  • use getattr_inclusive in all methods that accept name/names params
  • added index instance method
  • added Graphene integration
  • wrote Django and Graphene sections for docs/integration
  • removed children class attribute in Error classes (unnecessary and would require metaclasses to handle properly)
  • added strict version:
    • prevents mixing definition forms
    • enforces consistent attributes across instances
  • wrote Strict section for docs/customizing

0.3.0 - 2023-10-12

  • renamed label attribute to value
  • replaced canonical_name attribute and cn property with cname attribute
  • removed cn_lower (adds no value)
  • renamed cn_title to cname_pretty
  • wrote docs/index
  • wrote docs/customizing
  • defined docs nav order
  • replaced deepcopy strategy (for immutability) with _attrdir dict + custom attribute access methods, which also facilitates attributes overriding existing properties and methods when collisions occur
  • added as_dict, all_dict, as_tuple, and all_tuple

0.2.0 - 2023-10-09

  • renamed package to simpleset
  • renamed Object to Constant
  • renamed Object.define to Constant.define_set
  • renamed ErrorSet to Error
  • rewrote Error to subclass from itself (define_family, define_children)
  • wrote docs/cheatsheet
  • wrote docs/error

0.1.0 - 2023-10-09

  • complete rewrite to combine Object + ObjectMananger into single class and simplify API
  • added changelog
  • added changelog link to pyproject.toml for PyPI
  • added pytest to dev dependencies
  • configured pytest in pyproject.toml and tests/conftest.py
  • converted test.py to a pytest test suite stored under tests/
  • rewrote README to act as a preview of the docs

0.0.3 - 2023-10-08

  • added docs/ and mkdocs.yml for MkDocs (intitial version identical to README)
  • added .readthedocs.yaml for integration with Read the Docs
  • added documentation link to pyproject.toml for PyPI

0.0.2 - 2023-03-27

  • first working version