Metadata-Version: 2.1
Name: corallium
Version: 0.1.0rc1
Summary: Shared functionality for calcipy-ecosystem
Home-page: https://github.com/kyleking/corallium
License: MIT
Author: Kyle King
Author-email: dev.act.kyle@gmail.com
Requires-Python: >=3.8.12,<4.0.0
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: beartype (>=0.12.0)
Requires-Dist: pydantic (>=1.10.4)
Requires-Dist: rich (>=12.6.0)
Requires-Dist: tomli (>=2.0.1) ; python_version < "3.11"
Project-URL: Bug Tracker, https://github.com/kyleking/corallium/issues
Project-URL: Changelog, https://github.com/kyleking/corallium/blob/main/docs/docs/CHANGELOG.md
Project-URL: Documentation, https://corallium.kyleking.me
Project-URL: Repository, https://github.com/kyleking/corallium
Description-Content-Type: text/markdown

# corallium

Shared functionality for calcipy-ecosystem

## Installation

1. `poetry add `

1. ...

    ```sh
    import

    # < TODO: Add example code here >
    ```

1. ...

## Usage

<!-- < TODO: Show an example (screenshots, terminal recording, etc.) > -->

For more example code, see the [scripts] directory or the [tests].

## Project Status

See the `Open Issues` and/or the [CODE_TAG_SUMMARY]. For release history, see the [CHANGELOG].

## Contributing

We welcome pull requests! For your pull request to be accepted smoothly, we suggest that you first open a GitHub issue to discuss your idea. For resources on getting started with the code base, see the below documentation:

- [DEVELOPER_GUIDE]
- [STYLE_GUIDE]

## Code of Conduct

We follow the [Contributor Covenant Code of Conduct][contributor-covenant].

### Open Source Status

We try to reasonably meet most aspects of the "OpenSSF scorecard" from [Open Source Insights](https://deps.dev/pypi/corallium)

## Responsible Disclosure

If you have any security issue to report, please contact the project maintainers privately. You can reach us at [dev.act.kyle@gmail.com](mailto:dev.act.kyle@gmail.com).

## License

[LICENSE]

[changelog]: ./docs/CHANGELOG.md
[code_tag_summary]: ./docs/CODE_TAG_SUMMARY.md
[contributor-covenant]: https://www.contributor-covenant.org
[developer_guide]: ./docs/DEVELOPER_GUIDE.md
[license]: https://github.com/kyleking/corallium/LICENSE
[scripts]: https://github.com/kyleking/corallium/scripts
[style_guide]: ./docs/STYLE_GUIDE.md
[tests]: https://github.com/kyleking/corallium/tests

