# corallium
Shared functionality for the calcipy-ecosystem.
## Installation
1. `poetry add corallium`
1. Take advantage of the logger or other common functionality
```sh
form corallium.log import LOGGER
LOGGER.info('Hello!')
```
## Usage
<!-- < TODO: Show an example (screenshots, terminal recording, etc.) >
- **log**: TBD
- **pretty_process**: TBD
- **shell**: TBD
- **file_helpers**: TBD
- **tomllib**: This is a lightweight wrapper to backport `tomli` in place of `tomllib` until we can use Python >3.11. Use with `from corallium.tomllib import tomllib`
- **dot_dict**: has one function `ddict`, which is a light-weight wrapper around whatever is the most [maintained dotted-dictionary package in Python](https://pypi.org/search/?q=dot+accessible+dictionary&o=). Dotted dictionaries can sometimes improve code readability, but they aren't a one-size fits all solution. Sometimes `attr.s` or `dataclass` are more appropriate.
- The benefit of this wrapper is a stable interface that can be replaced with better internal implementations, such [Bunch](https://pypi.org/project/bunch/), [Chunk](https://pypi.org/project/chunk/), [Munch](https://pypi.org/project/munch/), [flexible-dotdict](https://pypi.org/project/flexible-dotdict/), [classy-json](https://pypi.org/project/classy-json/), and now [Python-Box](https://pypi.org/project/python-box/)
-->
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]: https://corallium.kyleking.me/docs/CHANGELOG
[code_tag_summary]: https://corallium.kyleking.me/docs/CODE_TAG_SUMMARY
[contributor-covenant]: https://www.contributor-covenant.org
[developer_guide]: https://corallium.kyleking.me/docs/DEVELOPER_GUIDE
[license]: https://github.com/kyleking/corallium/blob/main/LICENSE
[scripts]: https://github.com/kyleking/corallium/blob/main/scripts
[style_guide]: https://corallium.kyleking.me/docs/STYLE_GUIDE
[tests]: https://github.com/kyleking/corallium/blob/main/tests
Raw data
{
"_id": null,
"home_page": "https://github.com/kyleking/corallium",
"name": "corallium",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0.0,>=3.9.13",
"maintainer_email": null,
"keywords": "calcipy_template",
"author": "Kyle King",
"author_email": "dev.act.kyle@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/83/a6/2cae5e65d5640e404188f42b18ebadceb67033dcd769b38deb9647c076f4/corallium-2.1.1.tar.gz",
"platform": null,
"description": "# corallium\n\nShared functionality for the calcipy-ecosystem.\n\n## Installation\n\n1. `poetry add corallium`\n\n1. Take advantage of the logger or other common functionality\n\n ```sh\n form corallium.log import LOGGER\n\n LOGGER.info('Hello!')\n ```\n\n## Usage\n\n<!-- < TODO: Show an example (screenshots, terminal recording, etc.) >\n\n- **log**: TBD\n- **pretty_process**: TBD\n- **shell**: TBD\n- **file_helpers**: TBD\n- **tomllib**: This is a lightweight wrapper to backport `tomli` in place of `tomllib` until we can use Python >3.11. Use with `from corallium.tomllib import tomllib`\n- **dot_dict**: has one function `ddict`, which is a light-weight wrapper around whatever is the most [maintained dotted-dictionary package in Python](https://pypi.org/search/?q=dot+accessible+dictionary&o=). Dotted dictionaries can sometimes improve code readability, but they aren't a one-size fits all solution. Sometimes `attr.s` or `dataclass` are more appropriate.\n - The benefit of this wrapper is a stable interface that can be replaced with better internal implementations, such [Bunch](https://pypi.org/project/bunch/), [Chunk](https://pypi.org/project/chunk/), [Munch](https://pypi.org/project/munch/), [flexible-dotdict](https://pypi.org/project/flexible-dotdict/), [classy-json](https://pypi.org/project/classy-json/), and now [Python-Box](https://pypi.org/project/python-box/)\n -->\n\nFor more example code, see the [scripts] directory or the [tests].\n\n## Project Status\n\nSee the `Open Issues` and/or the [CODE_TAG_SUMMARY]. For release history, see the [CHANGELOG].\n\n## Contributing\n\nWe 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:\n\n- [DEVELOPER_GUIDE]\n- [STYLE_GUIDE]\n\n## Code of Conduct\n\nWe follow the [Contributor Covenant Code of Conduct][contributor-covenant].\n\n### Open Source Status\n\nWe try to reasonably meet most aspects of the \"OpenSSF scorecard\" from [Open Source Insights](https://deps.dev/pypi/corallium)\n\n## Responsible Disclosure\n\nIf 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).\n\n## License\n\n[LICENSE]\n\n[changelog]: https://corallium.kyleking.me/docs/CHANGELOG\n[code_tag_summary]: https://corallium.kyleking.me/docs/CODE_TAG_SUMMARY\n[contributor-covenant]: https://www.contributor-covenant.org\n[developer_guide]: https://corallium.kyleking.me/docs/DEVELOPER_GUIDE\n[license]: https://github.com/kyleking/corallium/blob/main/LICENSE\n[scripts]: https://github.com/kyleking/corallium/blob/main/scripts\n[style_guide]: https://corallium.kyleking.me/docs/STYLE_GUIDE\n[tests]: https://github.com/kyleking/corallium/blob/main/tests\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Shared functionality for the calcipy-ecosystem",
"version": "2.1.1",
"project_urls": {
"Bug Tracker": "https://github.com/kyleking/corallium/issues",
"Changelog": "https://github.com/kyleking/corallium/blob/main/docs/docs/CHANGELOG.md",
"Documentation": "https://corallium.kyleking.me",
"Homepage": "https://github.com/kyleking/corallium",
"Repository": "https://github.com/kyleking/corallium"
},
"split_keywords": [
"calcipy_template"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "56e391024524a6b1091ad561c3c25a0bcd1e7ec293bfd2506877312a235c552f",
"md5": "7c2bf54581668e7e2def99bb916167a4",
"sha256": "8f5deddb7b15282099e092399dc4918f23e6d6763ec78de79044e84877a3eed7"
},
"downloads": -1,
"filename": "corallium-2.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7c2bf54581668e7e2def99bb916167a4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0.0,>=3.9.13",
"size": 16596,
"upload_time": "2024-11-13T03:05:44",
"upload_time_iso_8601": "2024-11-13T03:05:44.157189Z",
"url": "https://files.pythonhosted.org/packages/56/e3/91024524a6b1091ad561c3c25a0bcd1e7ec293bfd2506877312a235c552f/corallium-2.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "83a62cae5e65d5640e404188f42b18ebadceb67033dcd769b38deb9647c076f4",
"md5": "45c32e1dac683b5393a56d61517a4c99",
"sha256": "aa142f137a8a77e511faba9592c710143a4c63d2cdc1e0b7b22d0f4d6835213f"
},
"downloads": -1,
"filename": "corallium-2.1.1.tar.gz",
"has_sig": false,
"md5_digest": "45c32e1dac683b5393a56d61517a4c99",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0.0,>=3.9.13",
"size": 14581,
"upload_time": "2024-11-13T03:05:45",
"upload_time_iso_8601": "2024-11-13T03:05:45.322368Z",
"url": "https://files.pythonhosted.org/packages/83/a6/2cae5e65d5640e404188f42b18ebadceb67033dcd769b38deb9647c076f4/corallium-2.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-13 03:05:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kyleking",
"github_project": "corallium",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "corallium"
}
JSON
