nshconfig

Name	nshconfig JSON
Version	0.35.0 JSON
	download
home_page	None
Summary	Fully typed configuration management, powered by Pydantic
upload_time	2024-12-18 18:05:22
maintainer	None
docs_url	None
author	Nima Shoghi
requires_python	<4.0,>=3.10
license	None
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # nshconfig

Fully typed configuration management, powered by [Pydantic](https://github.com/pydantic/pydantic/).

**[📚 Documentation](https://nima.sh/nshconfig/) | [🔧 Installation Guide](https://nima.sh/nshconfig/installation.html)**

## Overview

`nshconfig` is a Python library that enhances Pydantic with additional features for configuration management, particularly useful for machine learning experiments and other applications requiring strongly typed configurations.

## Installation

```bash
pip install nshconfig
```

To install all optional dependencies, use:

```bash
pip install nshconfig[extra]
```

Please see the [Installation Guide](https://nima.sh/nshconfig/installation.html) for more details.

## Quick Start

```python
import nshconfig as C

class MyConfig(C.Config):
    field1: int
    field2: str
    field3: C.AllowMissing[float] = C.MISSING

config = MyConfig.draft()
config.field1 = 42
config.field2 = "hello"
final_config = config.finalize()
```

## Key Features

- Draft configs for intuitive configuration creation
- Multiple configuration formats (Python, JSON, YAML)
- Dynamic type registry for plugin systems
- Configuration code generation tools
- Built-in PyTorch Lightning integration
- MISSING constant for optional fields

For detailed examples and API reference, please visit the [documentation](https://nima.sh/nshconfig/).

## Contributing

Contributions are welcome! Please see our [Contributing Guide](https://nima.sh/nshconfig/contributing.html) for details.

## Credit

Built on top of the excellent [pydantic](https://github.com/pydantic/pydantic/) library.

## License

MIT License

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "nshconfig",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.10",
    "maintainer_email": null,
    "keywords": null,
    "author": "Nima Shoghi",
    "author_email": "nimashoghi@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/4f/45/9862067d4362f8611fa5a4b84cecaa4a450d6de63b6be7a6e7efb056e87d/nshconfig-0.35.0.tar.gz",
    "platform": null,
    "description": "# nshconfig\n\nFully typed configuration management, powered by [Pydantic](https://github.com/pydantic/pydantic/).\n\n**[\ud83d\udcda Documentation](https://nima.sh/nshconfig/) | [\ud83d\udd27 Installation Guide](https://nima.sh/nshconfig/installation.html)**\n\n## Overview\n\n`nshconfig` is a Python library that enhances Pydantic with additional features for configuration management, particularly useful for machine learning experiments and other applications requiring strongly typed configurations.\n\n## Installation\n\n```bash\npip install nshconfig\n```\n\nTo install all optional dependencies, use:\n\n```bash\npip install nshconfig[extra]\n```\n\nPlease see the [Installation Guide](https://nima.sh/nshconfig/installation.html) for more details.\n\n## Quick Start\n\n```python\nimport nshconfig as C\n\nclass MyConfig(C.Config):\n    field1: int\n    field2: str\n    field3: C.AllowMissing[float] = C.MISSING\n\nconfig = MyConfig.draft()\nconfig.field1 = 42\nconfig.field2 = \"hello\"\nfinal_config = config.finalize()\n```\n\n## Key Features\n\n- Draft configs for intuitive configuration creation\n- Multiple configuration formats (Python, JSON, YAML)\n- Dynamic type registry for plugin systems\n- Configuration code generation tools\n- Built-in PyTorch Lightning integration\n- MISSING constant for optional fields\n\nFor detailed examples and API reference, please visit the [documentation](https://nima.sh/nshconfig/).\n\n## Contributing\n\nContributions are welcome! Please see our [Contributing Guide](https://nima.sh/nshconfig/contributing.html) for details.\n\n## Credit\n\nBuilt on top of the excellent [pydantic](https://github.com/pydantic/pydantic/) library.\n\n## License\n\nMIT License\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Fully typed configuration management, powered by Pydantic",
    "version": "0.35.0",
    "project_urls": {
        "homepage": "https://github.com/nimashoghi/nshconfig"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "64174caa5b871313209aaab7c05e481f8d2c1ca40979b6765c774137d433244b",
                "md5": "dfa057d9a978f189adba5c9921faca4a",
                "sha256": "18df9c610c67a166c1c32e5bc2f05778874b8b7d7f37ec878baf6603b85d340f"
            },
            "downloads": -1,
            "filename": "nshconfig-0.35.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "dfa057d9a978f189adba5c9921faca4a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.10",
            "size": 31737,
            "upload_time": "2024-12-18T18:05:21",
            "upload_time_iso_8601": "2024-12-18T18:05:21.644744Z",
            "url": "https://files.pythonhosted.org/packages/64/17/4caa5b871313209aaab7c05e481f8d2c1ca40979b6765c774137d433244b/nshconfig-0.35.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4f459862067d4362f8611fa5a4b84cecaa4a450d6de63b6be7a6e7efb056e87d",
                "md5": "62378f9378d11b32a0e1d2ad4334091b",
                "sha256": "d3d9b48701123aa286d66996f20dc7dfcfcaf01a87bfa059cd63c7dd72c523c8"
            },
            "downloads": -1,
            "filename": "nshconfig-0.35.0.tar.gz",
            "has_sig": false,
            "md5_digest": "62378f9378d11b32a0e1d2ad4334091b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.10",
            "size": 28230,
            "upload_time": "2024-12-18T18:05:22",
            "upload_time_iso_8601": "2024-12-18T18:05:22.752728Z",
            "url": "https://files.pythonhosted.org/packages/4f/45/9862067d4362f8611fa5a4b84cecaa4a450d6de63b6be7a6e7efb056e87d/nshconfig-0.35.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-18 18:05:22",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "nimashoghi",
    "github_project": "nshconfig",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "nshconfig"
}