feat(docs): add framework integrations and improve documentation structure #79
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- move TypeID implementation, factory, parsing, validation, constants, and errors into typeid.core - add typeid.codecs.base32 and keep typeid.base32 as a compatibility re-export - update public imports and tests to use new module paths - update CLI to live in typeid.cli.main and fix project script entrypoint - keep legacy modules (typeid.typeid, typeid.factory, typeid.validation, typeid.errors, typeid.constants) as shims
- introduce optional pydantic dependency (v2) - add TypeIDField for validating and serializing TypeID values - enforce TypeID prefix validation via generic field syntax - ensure JSON serialization outputs canonical string form - add integration tests covering parsing, validation, and serialization
…arsing - allow TypeIDField[Literal["prefix"]] (in addition to string/tuple forms) - use TypeID.from_string for parsing and simplify serialization/prefix checks - apply minor formatting/cleanup in cli init and errors import
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
refactor: reorganize core modules
feat(pydantic): add Pydantic v2 integration with TypeIDField