-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* docs: move to litestar * docs: add pages * docs: update changelog * docs: notate stability policy * ci: apply pre-commit * docs: fix version * docs: fix config
- Loading branch information
1 parent
982c27c
commit 25eb15b
Showing
24 changed files
with
1,093 additions
and
666 deletions.
There are no files selected for viewing
This file contains 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
Validating CODEOWNERS rules …
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| # Code owner settings for `jolt-org` | ||
| # Code owner settings for `litestar-org` | ||
| # @maintainers should be assigned to all reviews. | ||
| # Most specific assignment takes precedence though, so if you add a more specific thing than the `*` glob, you must also add @maintainers | ||
| # For more info about code owners see https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners#codeowners-file-example | ||
|
|
||
| # Global Assignment | ||
| * @jolt-org/maintainers @jolt-org/members | ||
| * @litestar-org/maintainers @litestar-org/members |
File renamed without changes.
File renamed without changes.
This file contains 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
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,65 +1,12 @@ | ||
| # dtos | ||
|
|
||
| Model your domain at the edge. | ||
|
|
||
| <div align="center"> | ||
|
|
||
| | Project | | Status | | ||
| | --------- | :-- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ||
| | CI/CD | | [](https://github.com/jolt-org/dtos/actions/workflows/publish.yaml) [](https://github.com/jolt-org/dtos/actions/workflows/ci.yaml) [](https://github.com/jolt-org/dtos/actions/workflows/docs.yaml) | | ||
| | Quality | | [](https://sonarcloud.io/summary/new_code?id=jolt-org_dtos) [](https://sonarcloud.io/summary/new_code?id=jolt-org_dtos) [](https://sonarcloud.io/summary/new_code?id=jolt-org_dtos) [](https://sonarcloud.io/summary/new_code?id=jolt-org_dtos) [](https://sonarcloud.io/summary/new_code?id=jolt-org_dtos) | | ||
| | Community | | [](https://discord.gg/XpFNTjjtTK) | | ||
| | Meta | | [](https://github.com/jolt-org/) [](https://github.com/python/mypy) [](https://spdx.org/licenses/) [](https://github.com/sponsors/jolt-org) [](https://github.com/astral-sh/ruff) [](https://github.com/psf/black) | | ||
|
|
||
| </div> | ||
|
|
||
| > **Warning**: Pre-Release Alpha Stage | ||
| > | ||
| > Please note that DTOS is currently in a pre-release alpha stage of development. This means the library is still under | ||
| > active development, and its API is subject to change. We encourage developers to experiment with DTOS and provide | ||
| > feedback, but we recommend against using it in production environments until a stable release is available.` | ||
| ## About | ||
|
|
||
| The `dtos` library bridges the gap between complex domain models and their practical usage across network boundaries. | ||
| It is designed for Python developers seeking to streamline the process of configuring different representations of | ||
| domain models, such as dataclasses and SQLAlchemy models, for network edge parsing and validation. Whether you're | ||
| looking to accept a subset, superset, or a completely customized set of fields defined on your model at the network | ||
| edge, `dtos` offers a flexible and powerful solution. | ||
|
|
||
| ## Purpose | ||
|
|
||
| ``dtos`` is built with the vision of enhancing domain modeling at the network edge, offering developers unparalleled control | ||
| over their data's shape and structure during transfer. The library facilitates: | ||
|
|
||
| - **Customizable Data Representations**: Tailor your data to meet the exact needs of your network interactions, enabling | ||
| a more efficient and precise data exchange. | ||
| - **Edge Parsing and Validation**: Ensure your data integrity by defining explicit parsing and validation rules that | ||
| match your application's requirements. | ||
| - **Seamless Integration**: Designed to work effortlessly with popular Python data modeling and ORM tools, ``dtos`` | ||
| integrates into your existing workflow with minimal overhead. | ||
|
|
||
| ## Contributing | ||
|
|
||
| All [Jolt][jolt-org] projects will always be a community-centered, available for contributions of any size. | ||
|
|
||
| Before contributing, please review the [contribution guide][contributing]. | ||
|
|
||
| If you have any questions, reach out to us on [Discord][discord], our org-wide [GitHub discussions][jolt-discussions] page, | ||
| or the [project-specific GitHub discussions page][project-discussions]. | ||
|
|
||
| <hr> | ||
|
|
||
| <!-- markdownlint-disable --> | ||
| <p align="center"> | ||
| <img src="https://raw.githubusercontent.com/jolt-org/branding/473f54621e55cde9acbb6fcab7fc03036173eb3d/assets/Branding%20-%20PNG%20-%20Transparent/Logo%20-%20Banner%20-%20Inline%20-%20Light.png" alt="Litestar Logo - Light" width="100%" height="auto" /> | ||
| <img src="https://raw.githubusercontent.com/litestar-org/branding/473f54621e55cde9acbb6fcab7fc03036173eb3d/assets/Branding%20-%20PNG%20-%20Transparent/Logo%20-%20Banner%20-%20Inline%20-%20Light.png" alt="Litestar Logo - Light" width="100%" height="auto" /> | ||
| </p> | ||
|
|
||
| [jolt-org]: https://github.com/jolt-org | ||
| [contributing]: https://docs.dtos.jolt.rs/latest/contribution-guide.html | ||
| [discord]: https://discord.gg/XpFNTjjtTK | ||
| [jolt-discussions]: https://github.com/orgs/jolt-org/discussions | ||
| [project-discussions]: https://github.com/jolt-org/dtos/discussions | ||
| [project-docs]: https://docs.dtos.jolt.rs | ||
| [install-guide]: https://docs.dtos.jolt.rs/latest/#installation | ||
| [newrepo]: https://github.com/organizations/jolt-org/repositories/new?template=dtos | ||
| [litestar-org]: https://github.com/litestar-org | ||
| [contributing]: https://docs.dtos.litestar.dev/latest/contribution-guide.html | ||
| [discord]: https://discord.gg/litestar | ||
| [litestar-discussions]: https://github.com/orgs/litestar-org/discussions | ||
| [project-discussions]: https://github.com/litestar-org/dtos/discussions | ||
| [project-docs]: https://docs.dtos.litestar.dev | ||
| [install-guide]: https://docs.dtos.litestar.dev/latest/#installation |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| ========= | ||
| Changelog | ||
| ========= | ||
|
|
||
| All commits to this project will be documented in this file. | ||
|
|
||
| `Release [v0.1.0] - 2024-04-26 <https://github.com/litestar-org/dtos/releases/tag/v0.1.0>`_ | ||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ||
| * `See All commits in v0.1.0 <https://github.com/litestar-org/dtos/commits/v0.1.0>`_ | ||
|
|
||
| Documentation | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| * (`e34f8f6 <https://github.com/litestar-org/dtos/commit/e34f8f6724d21cfd02e54380e47a14d5abb9f0ca>`_) - Move to litestar (Jacob Coffee) | ||
| * (`d019741 <https://github.com/litestar-org/dtos/commit/d01974125292d1afbdd36c07728f22bbf210a31f>`_) - Add pages (Jacob Coffee) | ||
|
|
||
| Miscellaneous Tasks | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| * (`88e2026 <https://github.com/litestar-org/dtos/commit/88e20261d8ab08d224072fc01fe3b4a5f077af49>`_) - Fix linting errors (Peter Schutt) | ||
| * (`90f21ec <https://github.com/litestar-org/dtos/commit/90f21ecc9b90f79435ca4f43edd41dc3762ba187>`_) - Updated type-lens dep to pre-release (Peter Schutt) | ||
| * (`6e16eeb <https://github.com/litestar-org/dtos/commit/6e16eeb877644a80c6b2db67868dc5202faadc2b>`_) - Use github readme admonition (Jacob Coffee) | ||
|
|
||
| Ci | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| * (`6f03cf1 <https://github.com/litestar-org/dtos/commit/6f03cf15893e39a06637f85d49173031cb51d8a8>`_) - Update py versions (Peter Schutt) | ||
|
|
||
| DTOs Changelog |
Oops, something went wrong.