Skip to content

Commit

Permalink
prep for 0.5.0 release
Browse files Browse the repository at this point in the history
Signed-off-by: Grant Ramsay <seapagan@gmail.com>
  • Loading branch information
seapagan committed Mar 7, 2024
1 parent 7d98833 commit 421c2d8
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 7 deletions.
27 changes: 27 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,32 @@
# 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](https://semver.org/spec/v2.0.0.html).

## [0.5.0](https://github.com/seapagan/simple-toml-settings/releases/tag/0.5.0) (2024-03-07)

**New Features**

- Add an optional singleton method ([#136](https://github.com/seapagan/simple-toml-settings/pull/136)) by [seapagan](https://github.com/seapagan)

**Refactoring**

- Fix formatting to Ruff 3.0 standard ([#131](https://github.com/seapagan/simple-toml-settings/pull/131)) by [seapagan](https://github.com/seapagan)

**Documentation**

- Fix some errors and typos in the docs ([#124](https://github.com/seapagan/simple-toml-settings/pull/124)) by [seapagan](https://github.com/seapagan)

**Dependency Updates**

- Bump ruff from 0.2.1 to 0.3.0 ([#130](https://github.com/seapagan/simple-toml-settings/pull/130)) by [dependabot[bot]](https://github.com/apps/dependabot)
- Bump cryptography from 42.0.0 to 42.0.4 ([#123](https://github.com/seapagan/simple-toml-settings/pull/123)) by [dependabot[bot]](https://github.com/apps/dependabot)
- Bump github-changelog-md from 0.8.1 to 0.9.1 ([#122](https://github.com/seapagan/simple-toml-settings/pull/122)) by [dependabot[bot]](https://github.com/apps/dependabot)

[`Full Changelog`](https://github.com/seapagan/simple-toml-settings/compare/0.4.0...0.5.0) | [`Diff`](https://github.com/seapagan/simple-toml-settings/compare/0.4.0...0.5.0.diff) | [`Patch`](https://github.com/seapagan/simple-toml-settings/compare/0.4.0...0.5.0.patch)

## [0.4.0](https://github.com/seapagan/simple-toml-settings/releases/tag/0.4.0) (2024-02-14)

**New Features**
Expand Down
12 changes: 6 additions & 6 deletions TODO.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# Future Plans

- Allow a custom folder root (not just users $HOME) folder, as well as custom
file name.
- Allow a custom folder root (not just users $HOME) folder.
- Add an option to just store the config file in the users home directory. The
default option of putting it in a sub-folder of the project is useful for
projects that need to store extra data, but may be overkill for basic
projects.
- Add Option to look for the config file in the current directory, and if not
- Add an Option to look for the config file in the current directory, and if not
found then look in the users home directory.
- Add an Option to not include the `schema_version` key. By default this key
**will** be included. **This will only be ommited if the `schema_version` is
'none'**.
- Allow a global config file to be used, which will be overridden by a local
config file if it exists.
- option to not save config options that have the same value as the default.
- by default save should not save config options that are not already in the
- Add an option to not save config options that have the same value as the
default.
- By default `save()` should not save config options that are not already in the
config file, though leave the current behavior as an option.
- raise a specific custom exception for malformed TOML files
- Raise a specific custom exception for malformed TOML files
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "simple-toml-settings"
version = "0.4.0"
version = "0.5.0"
description = "A Python library to save your settings in a TOML file."
authors = ["Grant Ramsay <seapagan@gmail.com>"]
readme = "README.md"
Expand Down

0 comments on commit 421c2d8

Please sign in to comment.