Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

V2 #310

Merged
merged 7 commits into from
Aug 19, 2024
Merged

V2 #310

merged 7 commits into from
Aug 19, 2024

Conversation

dbatten5
Copy link
Owner

@dbatten5 dbatten5 commented Aug 18, 2024

This PR introduces some breaking changes.

Renaming ProjectConfig to UserConfig

The new name better reflects what the object represents, the user's configuration.

The renaming also includes some other changes to the API:

  • The config values are now accessed through UserConfig().values.
  • The project_name has been renamed to package_name to better reflect that it refers to the configuration of the package, not the user's project.

Removing pydantic as a dependency

Previously this was a dependency of maison. This meant that any installs of maison will also install pydantic, but pydantic was only used for an optional part of this package (validation). The use of pydantic to perform validation against a schema is still preferred, but it's now up to the user to include this dependency.

Dropping 3.8 support

This was done in #311

@dbatten5 dbatten5 force-pushed the v2.2 branch 4 times, most recently from 9d41bc9 to 8016734 Compare August 19, 2024 08:41
This replaces the `ProjectConfig` class to be used as the main API.
The new interface should be simpler to use and more intuitive as it
exposes a `values` property that behaves like a dict object.
This name better reflects what `maison` is searching for.
We have some tests of the schema functionality using `pydantic`. To
ensure that the `pydantic` integration works we need to add it to the
test dependencies now that it's been removed from the main dependencies
The `dict` method is deprecated
@dbatten5 dbatten5 merged commit da3e0a0 into main Aug 19, 2024
22 checks passed
@dbatten5 dbatten5 deleted the v2.2 branch August 19, 2024 08:45
@dbatten5 dbatten5 mentioned this pull request Aug 21, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant