python-immutable

Name	python-immutable JSON
Version	1.1.1 JSON
	download
home_page	None
Summary	Immutable implementation for Python using dataclasses
upload_time	2024-05-06 20:52:47
maintainer	None
docs_url	None
author	Sassan Haradji
requires_python	<4.0,>=3.9
license	Apache-2.0
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # README.md for Immutable Library

## Overview

This library provides decorators and base classes to create immutable data classes
in Python. By enforcing immutability and keyword-only arguments, it enhances the
robustness and clarity of your data structures.

## 📋 Requirements

- Python 3.9 or later.
- No external dependencies are required.

## 📦 Installation

### Pip

```bash
pip install python-immutable
```

### Poetry

```bash
poetry add python-immutable
```

## 🛠 Usage

### Using `immutable` Decorator

Apply `immutable` to a class to make it immutable and enforce keyword-only arguments.

```python
from immutable import immutable

@immutable
class MyClass:
    # Fields here
```

### Extending `Immutable` Base Class

Inherit from `Immutable` for similar functionality.

```python
from immutable import Immutable

class MyClass(Immutable):
    # Fields here
```

## 🤝 Contributing

Contributions are welcome. Please submit pull requests or issues on the GitHub repository.

### ⚠️ Important Note

Ensure compatibility with Python 3.9 or newer when contributing.

## 🔒 License

This project is released under the Apache-2.0 License. See the [LICENSE](./LICENSE)
file for more details.


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "python-immutable",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": "Sassan Haradji",
    "author_email": "sassanh@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/f1/cc/ee90e8e3d3be888f22ed9fa425c5a69cd6387bea7013a3466b069cabd7f1/python_immutable-1.1.1.tar.gz",
    "platform": null,
    "description": "# README.md for Immutable Library\n\n## Overview\n\nThis library provides decorators and base classes to create immutable data classes\nin Python. By enforcing immutability and keyword-only arguments, it enhances the\nrobustness and clarity of your data structures.\n\n## \ud83d\udccb Requirements\n\n- Python 3.9 or later.\n- No external dependencies are required.\n\n## \ud83d\udce6 Installation\n\n### Pip\n\n```bash\npip install python-immutable\n```\n\n### Poetry\n\n```bash\npoetry add python-immutable\n```\n\n## \ud83d\udee0 Usage\n\n### Using `immutable` Decorator\n\nApply `immutable` to a class to make it immutable and enforce keyword-only arguments.\n\n```python\nfrom immutable import immutable\n\n@immutable\nclass MyClass:\n    # Fields here\n```\n\n### Extending `Immutable` Base Class\n\nInherit from `Immutable` for similar functionality.\n\n```python\nfrom immutable import Immutable\n\nclass MyClass(Immutable):\n    # Fields here\n```\n\n## \ud83e\udd1d Contributing\n\nContributions are welcome. Please submit pull requests or issues on the GitHub repository.\n\n### \u26a0\ufe0f Important Note\n\nEnsure compatibility with Python 3.9 or newer when contributing.\n\n## \ud83d\udd12 License\n\nThis project is released under the Apache-2.0 License. See the [LICENSE](./LICENSE)\nfile for more details.\n\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "Immutable implementation for Python using dataclasses",
    "version": "1.1.1",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ad29c66c6ac9c7acdeb493c895ed5b8094c8f94e2b335a7f8e5390ea0f22e315",
                "md5": "a98770a392f4fb2ebf6e027f32515f22",
                "sha256": "56feffc7c628c404b6a49c08e35b53690aa36ec6284ff105233a1b34c4a04048"
            },
            "downloads": -1,
            "filename": "python_immutable-1.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a98770a392f4fb2ebf6e027f32515f22",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.9",
            "size": 7366,
            "upload_time": "2024-05-06T20:52:45",
            "upload_time_iso_8601": "2024-05-06T20:52:45.235987Z",
            "url": "https://files.pythonhosted.org/packages/ad/29/c66c6ac9c7acdeb493c895ed5b8094c8f94e2b335a7f8e5390ea0f22e315/python_immutable-1.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f1ccee90e8e3d3be888f22ed9fa425c5a69cd6387bea7013a3466b069cabd7f1",
                "md5": "ce6f1d7f5c083611f35da27ea066b102",
                "sha256": "c7aa209f69c02793b8cdb8b645d186beb159ba37f3a30ffdbc66474d06db96a0"
            },
            "downloads": -1,
            "filename": "python_immutable-1.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "ce6f1d7f5c083611f35da27ea066b102",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.9",
            "size": 6612,
            "upload_time": "2024-05-06T20:52:47",
            "upload_time_iso_8601": "2024-05-06T20:52:47.193721Z",
            "url": "https://files.pythonhosted.org/packages/f1/cc/ee90e8e3d3be888f22ed9fa425c5a69cd6387bea7013a3466b069cabd7f1/python_immutable-1.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-06 20:52:47",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "python-immutable"
}