schematized config
================
<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
## Install
``` sh
pip install python_schematized_config
```
## usage
``` python
from schematized_config.core import ConfigValidator
```
``` python
import os
import os.path as _p
if _p.exists('.env') and 'CONFIG_VALIDATOR_JSON_SCHEMA' in os.environ:
ConfigValidator.load_dotenv() # use defaults of .env and CONFIG_VALIDATOR_JSON_SCHEMA
```
# development
<details>
<summary>
entering the development environment
</summary>
assuming you have [nix](https://nixos.org/download.html) installed and
ready, make sure `nix-command` and `flake` are enabled (oneliner: run
`export NIX_CONFIG="experimental-features = nix-command flakes"` in the
terminal), then enter the dev shell using `nix develop`
start the jupyter notebook using the provided alias or just
`jupyter notebook`, and hack away
</details>
## nbdev
this package is developed using [nbdev](https://nbdev.fast.ai/), so we
use an nbdev-centric development flow. For a quick guide, we recommend
checking out the [end-to-end
walkthrough](https://nbdev.fast.ai/tutorials/tutorial.html). But in
short: edit notebooks, then run the `nbdev_*` management commands. The
most essential flow is as follows:
1. edit the notebook files (core fore core, and cli for the command
line interface)
2. `python setup.py install` \# note we don’t use `nbdev_install`
because we manage `quarto` using `nix`
3. `nbdev_prepare`
4. run code using the package
5. `nbdev_release`
6. `nbdev_pypi`
### running tests
if you share variables between cells in your test blocks, this causes
trouble during `nbdev_prepare` as it tries to run cells in isolation,
leading to e.g.
NameError: name 'example_properties_schema' is not defined
to deal with this, you can merge cells that use a common variable
### updating package dependencies
note that package dependencies are specified in
[settings.ini](./settings.ini); you shouldn’t be editing `setup.py` by
hand. To add a requirement, add it to the `requuirements` entry in
`settings.ini`, then run `python setup.py install`
Raw data
{
"_id": null,
"home_page": "https://github.com/tutankalex/python-schematized-config",
"name": "python-schematized-config",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "nbdev jupyter notebook python",
"author": "tutankalex",
"author_email": "109660532+tutankalex@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/77/6a/3e839b856499a50471d09f4cfea49b2f161eeb4c39e711fea64df4b5993f/python-schematized-config-0.0.13.tar.gz",
"platform": null,
"description": "schematized config\n================\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\n## Install\n\n``` sh\npip install python_schematized_config\n```\n\n## usage\n\n``` python\nfrom schematized_config.core import ConfigValidator\n```\n\n``` python\nimport os\nimport os.path as _p\n\nif _p.exists('.env') and 'CONFIG_VALIDATOR_JSON_SCHEMA' in os.environ:\n ConfigValidator.load_dotenv() # use defaults of .env and CONFIG_VALIDATOR_JSON_SCHEMA\n```\n\n# development\n\n<details>\n<summary>\nentering the development environment\n</summary>\n\nassuming you have [nix](https://nixos.org/download.html) installed and\nready, make sure `nix-command` and `flake` are enabled (oneliner: run\n`export NIX_CONFIG=\"experimental-features = nix-command flakes\"` in the\nterminal), then enter the dev shell using `nix develop`\n\nstart the jupyter notebook using the provided alias or just\n`jupyter notebook`, and hack away\n</details>\n\n## nbdev\n\nthis package is developed using [nbdev](https://nbdev.fast.ai/), so we\nuse an nbdev-centric development flow. For a quick guide, we recommend\nchecking out the [end-to-end\nwalkthrough](https://nbdev.fast.ai/tutorials/tutorial.html). But in\nshort: edit notebooks, then run the `nbdev_*` management commands. The\nmost essential flow is as follows:\n\n1. edit the notebook files (core fore core, and cli for the command\n line interface)\n2. `python setup.py install` \\# note we don\u2019t use `nbdev_install`\n because we manage `quarto` using `nix`\n3. `nbdev_prepare`\n4. run code using the package\n5. `nbdev_release`\n6. `nbdev_pypi`\n\n### running tests\n\nif you share variables between cells in your test blocks, this causes\ntrouble during `nbdev_prepare` as it tries to run cells in isolation,\nleading to e.g.\n\n NameError: name 'example_properties_schema' is not defined\n\nto deal with this, you can merge cells that use a common variable\n\n### updating package dependencies\n\nnote that package dependencies are specified in\n[settings.ini](./settings.ini); you shouldn\u2019t be editing `setup.py` by\nhand. To add a requirement, add it to the `requuirements` entry in\n`settings.ini`, then run `python setup.py install`\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "validate configs using json schema",
"version": "0.0.13",
"project_urls": {
"Homepage": "https://github.com/tutankalex/python-schematized-config"
},
"split_keywords": [
"nbdev",
"jupyter",
"notebook",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f3c220be318b5f2a7aa304958e389d01c5b57fdfc9cb601cf84c8a34d6a169b2",
"md5": "761bcd20585009a511b0963807196229",
"sha256": "616a115927127c52befe04766f86cc72ac4bc8aa3ee83663db8cb55865b2d6c2"
},
"downloads": -1,
"filename": "python_schematized_config-0.0.13-py3-none-any.whl",
"has_sig": false,
"md5_digest": "761bcd20585009a511b0963807196229",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 12790,
"upload_time": "2024-11-14T15:02:12",
"upload_time_iso_8601": "2024-11-14T15:02:12.558452Z",
"url": "https://files.pythonhosted.org/packages/f3/c2/20be318b5f2a7aa304958e389d01c5b57fdfc9cb601cf84c8a34d6a169b2/python_schematized_config-0.0.13-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "776a3e839b856499a50471d09f4cfea49b2f161eeb4c39e711fea64df4b5993f",
"md5": "96c7d5290373936b6bab4ded0f469920",
"sha256": "fdfbce75b12c9d1eb426a157bc2a57b4e12d6ee3ee6034c289a505510acaefcf"
},
"downloads": -1,
"filename": "python-schematized-config-0.0.13.tar.gz",
"has_sig": false,
"md5_digest": "96c7d5290373936b6bab4ded0f469920",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 12731,
"upload_time": "2024-11-14T15:02:14",
"upload_time_iso_8601": "2024-11-14T15:02:14.386724Z",
"url": "https://files.pythonhosted.org/packages/77/6a/3e839b856499a50471d09f4cfea49b2f161eeb4c39e711fea64df4b5993f/python-schematized-config-0.0.13.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-14 15:02:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tutankalex",
"github_project": "python-schematized-config",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "python-schematized-config"
}
JSON
