generated from jolt-org/project-template
-
-
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: fix discord link * docs: add pages * docs: update changelog, add filler content * ci: apply pre-commit * docs: fix version * docs: fix config and changelog
- Loading branch information
1 parent
2076afe
commit cd923d5
Showing
20 changed files
with
1,233 additions
and
718 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 |
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
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,56 +1,11 @@ | ||
| # type-lens | ||
|
|
||
| <div align="center"> | ||
|
|
||
| | Project | | Status | | ||
| | --------- | :-- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ||
| | CI/CD | | [](https://github.com/jolt-org/type-lens/actions/workflows/publish.yaml) [](https://github.com/jolt-org/type-lens/actions/workflows/ci.yaml) [](https://github.com/jolt-org/type-lens/actions/workflows/docs.yaml) | | ||
| | Quality | | [](https://sonarcloud.io/summary/new_code?id=jolt-org_type-lens) [](https://sonarcloud.io/summary/new_code?id=jolt-org_type-lens) [](https://sonarcloud.io/summary/new_code?id=jolt-org_type-lens) [](https://sonarcloud.io/summary/new_code?id=jolt-org_type-lens) [](https://sonarcloud.io/summary/new_code?id=jolt-org_type-lens) | | ||
| | 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 `type-lens` 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 `type-lens` and | ||
| > provide feedback, but we recommend against using it in production environments until a stable release is available. | ||
| ## About | ||
|
|
||
| `type-lens` is a library that allows for utilizing Python types at runtime. | ||
|
|
||
| ## Usage | ||
|
|
||
| - Install `type-lens` with `pip` or check out [our installation guide][install-guide] | ||
|
|
||
| ```shell | ||
| pip install type-lens | ||
| ``` | ||
|
|
||
| ## 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.type-lens.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/type-lens/discussions | ||
| [project-docs]: https://docs.type-lens.jolt.rs | ||
| [install-guide]: https://docs.type-lens.jolt.rs/latest/#installation | ||
| [newrepo]: https://github.com/organizations/jolt-org/repositories/new?template=type-lens | ||
| [litestar-org]: https://github.com/litestar-org | ||
| [contributing]: https://docs.type-lens.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/type-lens/discussions | ||
| [project-docs]: https://docs.type-lens.litestar.dev |
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,38 @@ | ||
| ========= | ||
| Changelog | ||
| ========= | ||
|
|
||
| All commits to this project will be documented in this file. | ||
|
|
||
| `Release [v0.1.0a1] - 2024-04-26 <https://github.com/litestar-org/type-lens/releases/tag/v0.1.0a1>`_ | ||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ||
| * `See All commits in v0.1.0a1 <https://github.com/litestar-org/type-lens/commits/v0.1.0a1>`_ | ||
|
|
||
| `0e209be <https://github.com/litestar-org/type-lens/commit/0e209be1dc0bf99a0163ec4cdc15e36e4d21eb2b>`_ ... `567f49a <https://github.com/litestar-org/type-lens/commit/567f49ae117ff5d3619f857cbf986d454ef7e9fa>`_ | `See diff for 0.1.0a1 <https://github.com/litestar-org/type-lens/compare/0e209be1dc0bf99a0163ec4cdc15e36e4d21eb2b...567f49ae117ff5d3619f857cbf986d454ef7e9fa>`_ | ||
|
|
||
| Bug Fixes | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| * (`6405898 <https://github.com/litestar-org/type-lens/commit/64058981550b0ca41538fe8a706cd782a885dc4d>`_) - Add ParameterView to pkg ns (Peter Schutt) | ||
|
|
||
| Documentation | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| * (`3d80638 <https://github.com/litestar-org/type-lens/commit/3d806380f3e9b6b6d2a02c0bfbca866701f7df8a>`_) - Move to litestar (Jacob Coffee) | ||
| * (`bea1211 <https://github.com/litestar-org/type-lens/commit/bea12110642f52e7df44ab0a088cdc63a618915c>`_) - Fix discord link (Jacob Coffee) | ||
| * (`55ef5f6 <https://github.com/litestar-org/type-lens/commit/55ef5f6b161ec20c7691e656ea525fc61d71c8a5>`_) - Add pages (Jacob Coffee) | ||
| * (`14b0898 <https://github.com/litestar-org/type-lens/commit/14b08987f33a88f56a1a6e4084695cb74c5e2ae8>`_) - Update changelog, add filler content (Jacob Coffee) | ||
| * (`567f49a <https://github.com/litestar-org/type-lens/commit/567f49ae117ff5d3619f857cbf986d454ef7e9fa>`_) - Fix version (Jacob Coffee) | ||
|
|
||
| Refactor | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| * (`105043a <https://github.com/litestar-org/type-lens/commit/105043af379af5c8f8670f276767e9c0ac830b1c>`_) - Better Empty type (Peter Schutt) | ||
| * (`2076afe <https://github.com/litestar-org/type-lens/commit/2076afe75f4a1a0c23d50e245a27bdd388cfaa1e>`_) - Use plain old python classes (Peter Schutt) | ||
|
|
||
| Ci | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| * (`0da8b24 <https://github.com/litestar-org/type-lens/commit/0da8b245d3bea78b3caad01a1c319f79bbb13f36>`_) - Apply pre-commit (Jacob Coffee) | ||
|
|
||
| Type Lens Changelog |
Oops, something went wrong.