Changelog

This is an auto-generated log of all the changes that have been made to the project since the first release.

This project adheres to Semantic Versioning.

0.8.0 (2024-08-22)

New Features

• Add 'allow_missing_file' option (#254) by seapagan
• Mark some options as mutually exclusive and raise exception if more than one used (#245) by seapagan

Dependency Updates

• Bump mkdocs-material from 9.5.31 to 9.5.32 (#253) by dependabot[bot]
• Bump github-changelog-md from 0.9.4 to 0.9.5 (#252) by dependabot[bot]
• Bump faker from 26.1.0 to 27.0.0 (#251) by dependabot[bot]
• Bump ruff from 0.5.6 to 0.6.1 (#250) by dependabot[bot]
• Bump pymarkdownlnt from 0.9.21 to 0.9.22 (#247) by dependabot[bot]
• Bump mypy from 1.11.0 to 1.11.1 (#243) by dependabot[bot]
• Bump mkdocs-material from 9.5.30 to 9.5.31 (#242) by dependabot[bot]
• Bump faker from 26.0.0 to 26.1.0 (#241) by dependabot[bot]
• Bump ruff from 0.5.5 to 0.5.6 (#240) by dependabot[bot]
• Bump pytest from 8.2.2 to 8.3.2 (#239) by dependabot[bot]
• and 3 more dependency updates

Full Changelog | Diff | Patch

0.7.0 (2024-07-29)

New Features

• Add option to use the XDG_CONFIG_HOME env variable or standard default if not set (#231) by borland502

Bug Fixes

• Disable coverage upload if token not set (#232) by seapagan

Documentation

• Document the new XDG option (#234) by seapagan
• Clarify contribution information (#218) by seapagan

Dependency Updates

• Bump ruff from 0.5.1 to 0.5.5 (#233) by dependabot[bot]
• Bump mypy from 1.10.1 to 1.11.0 (#229) by dependabot[bot]
• Bump poethepoet from 0.26.1 to 0.27.0 (#228) by dependabot[bot]
• Bump pymarkdownlnt from 0.9.20 to 0.9.21 (#227) by dependabot[bot]
• Bump setuptools from 69.1.1 to 70.0.0 (#225) by dependabot[bot]
• Bump rtoml from 0.10.0 to 0.11.0 (#223) by dependabot[bot]
• Bump mypy from 1.10.0 to 1.10.1 (#222) by dependabot[bot]
• Bump github-changelog-md from 0.9.3 to 0.9.4 (#221) by dependabot[bot]
• Bump pyfakefs from 5.5.0 to 5.6.0 (#220) by dependabot[bot]
• Bump mkdocs-material from 9.5.28 to 9.5.29 (#219) by dependabot[bot]
• and 18 more dependency updates

Full Changelog | Diff | Patch

0.6.1 (2024-05-02)

New Features

• Relax some dependency version specs (#179) by seapagan

Dependency Updates

• Bump poethepoet from 0.25.0 to 0.26.1 (#178) by dependabot[bot]
• Bump mkdocs-material from 9.5.17 to 9.5.20 (#176) by dependabot[bot]
• Bump pytest from 8.1.1 to 8.2.0 (#174) by dependabot[bot]
• Bump pymdown-extensions from 10.7.1 to 10.8.1 (#173) by dependabot[bot]
• Bump mypy from 1.9.0 to 1.10.0 (#172) by dependabot[bot]
• Bump ruff from 0.3.5 to 0.4.2 (#171) by dependabot[bot]
• Bump faker from 24.3.0 to 24.14.0 (#170) by dependabot[bot]
• Bump pyfakefs from 5.3.5 to 5.4.1 (#165) by dependabot[bot]
• Bump idna from 3.6 to 3.7 (#164) by dependabot[bot]
• Bump pytest-watcher from 0.4.1 to 0.4.2 (#159) by dependabot[bot]
• and 9 more dependency updates

Full Changelog | Diff | Patch

0.6.0 (2024-03-11)

New Features

• Implement a flat_config option. (#142) by seapagan

Dependency Updates

• Bump ruff from 0.3.1 to 0.3.2 (#141) by dependabot[bot]
• Bump mypy from 1.8.0 to 1.9.0 (#140) by dependabot[bot]
• Bump faker from 24.0.0 to 24.1.0 (#139) by dependabot[bot]
• Bump pytest from 8.0.2 to 8.1.1 (#138) by dependabot[bot]

Full Changelog | Diff | Patch

0.5.0 (2024-03-07)

Closed Issues

New Features

• Add an optional singleton method (#136) by seapagan

Refactoring

• Fix formatting to Ruff 3.0 standard (#131) by seapagan

Documentation

• Fix some errors and typos in the docs (#124) by seapagan

Dependency Updates

• Bump mkdocs-material from 9.5.9 to 9.5.13 (#135) by dependabot[bot]
• Bump faker from 23.1.0 to 24.0.0 (#134) by dependabot[bot]
• Bump mkdocs-autorefs from 0.5.0 to 1.0.1 (#133) by dependabot[bot]
• Bump ruff from 0.2.1 to 0.3.0 (#130) by dependabot[bot]
• Bump poethepoet from 0.24.4 to 0.25.0 (#126) by dependabot[bot]
• Bump cryptography from 42.0.0 to 42.0.4 (#123) by dependabot[bot]
• Bump github-changelog-md from 0.8.1 to 0.9.1 (#122) by dependabot[bot]

Full Changelog | Diff | Patch

0.4.0 (2024-02-14)

New Features

• Raise schema error if the file schema does not match the required schema (#111) by seapagan

Documentation

• Add a SECURITY file (#120) by seapagan

Dependency Updates

• Bump mypy from 1.7.1 to 1.8.0 (#119) by dependabot[bot]
• Bump pymarkdownlnt from 0.9.15 to 0.9.17 (#118) by dependabot[bot]
• Bump pre-commit from 3.6.0 to 3.6.1 (#117) by dependabot[bot]
• Bump ruff from 0.1.8 to 0.2.1 (#116) by dependabot[bot]
• Bump pytest-sugar from 0.9.7 to 1.0.0 (#115) by dependabot[bot]
• Bump github-changelog-md from 0.8.0 to 0.8.1 (#114) by dependabot[bot]
• Bump pytest from 7.4.3 to 8.0.0 (#113) by dependabot[bot]
• Bump mkdocs-material from 9.5.2 to 9.5.9 (#112) by dependabot[bot]
• Bump faker from 20.0.3 to 23.1.0 (#110) by dependabot[bot]
• Bump cryptography from 41.0.6 to 42.0.0 (#107) by dependabot[bot]
• and 33 more dependency updates

Full Changelog | Diff | Patch

0.3.2 (2023-11-02)

Bug Fixes

• Don't save None values to the TOML file. (#49) by seapagan

Dependency Updates

• Bump pymarkdownlnt from 0.9.13.4 to 0.9.14 (#48) by dependabot[bot]
• Bump faker from 19.12.1 to 19.13.0 (#47) by dependabot[bot]
• Bump github-changelog-md from 0.3.0 to 0.5.0 (#46) by dependabot[bot]
• Bump faker from 19.11.0 to 19.12.1 (#45) by dependabot[bot]
• Bump pytest-asyncio from 0.21.1 to 0.22.0 (#44) by dependabot[bot]
• Bump pytest from 7.4.2 to 7.4.3 (#42) by dependabot[bot]
• Bump mkdocs-material from 9.4.6 to 9.4.7 (#41) by dependabot[bot]

Full Changelog | Diff | Patch

0.3.1 (2023-10-28)

Refactoring

• Change to new CHANGELOG generator. Mine :) (#38) by seapagan
• Migrate to ruff linter and formatter (#37) by seapagan

Dependency Updates

• Bump black from 23.10.0 to 23.10.1 (#36) by dependabot[bot]
• Bump pylint from 3.0.1 to 3.0.2 (#35) by dependabot[bot]
• Bump pylint-pytest from 1.1.2 to 1.1.3 (#34) by dependabot[bot]
• Bump pytest-mock from 3.11.1 to 3.12.0 (#33) by dependabot[bot]
• Bump pymdown-extensions from 10.3 to 10.3.1 (#32) by dependabot[bot]
• Bump faker from 19.10.0 to 19.11.0 (#31) by dependabot[bot]
• Bump black from 23.9.1 to 23.10.0 (#30) by dependabot[bot]
• Bump flake8-type-checking from 2.5.0 to 2.5.1 (#29) by dependabot[bot]
• Bump mypy from 1.6.0 to 1.6.1 (#28) by dependabot[bot]

Full Changelog | Diff | Patch

0.3.0 (2023-10-18)

New Features

• Allow a Local config file (#25) by seapagan
• Add 'auto_create' option for config file, default True (#22) by seapagan

Documentation

• Add missing repo section to docs (#21) by seapagan

Dependency Updates

• Bump urllib3 from 2.0.6 to 2.0.7 (#27) by dependabot[bot]
• Bump flake8-type-checking from 2.4.2 to 2.5.0 (#26) by dependabot[bot]
• Bump mkdocs-material from 9.4.5 to 9.4.6 (#24) by dependabot[bot]
• Bump pre-commit from 3.4.0 to 3.5.0 (#23) by dependabot[bot]
• Bump pyfakefs from 5.2.4 to 5.3.0 (#20) by dependabot[bot]
• Bump faker from 19.9.0 to 19.10.0 (#19) by dependabot[bot]

Full Changelog | Diff | Patch

0.2.2 (2023-10-12)

Bug Fixes

• Docs: fix same example error in README (#18) by seapagan
• Fix error on docs front page example code (#17) by seapagan

Full Changelog | Diff | Patch

0.2.1 (2023-10-12)

Bug Fixes

• Add 'py.typed' file so mypy can typecheck package (#16) by seapagan

Dependency Updates

• Bump faker from 19.8.0 to 19.9.0 (#15) by dependabot[bot]
• Bump mypy from 1.5.1 to 1.6.0 (#14) by dependabot[bot]
• Bump pylint from 2.17.7 to 3.0.1 (#13) by dependabot[bot]
• Bump faker from 19.6.2 to 19.8.0 (#12) by dependabot[bot]
• Bump mkdocs-material from 9.4.4 to 9.4.5 (#11) by dependabot[bot]

Full Changelog | Diff | Patch

0.2.0 (2023-10-10)

New Features

• Add a hook, called if the config file is missing and freshly created (#10) by seapagan

Dependency Updates

• Bump pylint-pydantic from 0.2.4 to 0.3.0 (#9) by dependabot[bot]
• Bump actions/checkout from 3 to 4 (#7) by dependabot[bot]

Full Changelog | Diff | Patch

0.1.0 (2023-10-09)

Merged Pull Requests

• Add test workflow to Github Actions (#2) by seapagan

Refactoring

• Rename main settings class (#5) by seapagan

Documentation

• Add basic documentation for the library (#3) by seapagan

This changelog was generated using github-changelog-md by Seapagan