Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adriamontoto/value-object-pattern
The Value Object Pattern is a Python 🐍 package that streamlines the creation and management of value objects 📦 in your projects. Value objects are immutable, self-validating objects that represent descriptive aspects of the domain with no conceptual identity.
https://github.com/adriamontoto/value-object-pattern
development domain-driven-design encapsulation pattern python python3 python311 python312 tools utilities validation value-object
Last synced: 15 days ago
JSON representation
The Value Object Pattern is a Python 🐍 package that streamlines the creation and management of value objects 📦 in your projects. Value objects are immutable, self-validating objects that represent descriptive aspects of the domain with no conceptual identity.
- Host: GitHub
- URL: https://github.com/adriamontoto/value-object-pattern
- Owner: adriamontoto
- License: mit
- Created: 2024-12-17T12:17:32.000Z (about 2 months ago)
- Default Branch: master
- Last Pushed: 2025-01-28T10:18:25.000Z (16 days ago)
- Last Synced: 2025-01-29T04:15:42.711Z (15 days ago)
- Topics: development, domain-driven-design, encapsulation, pattern, python, python3, python311, python312, tools, utilities, validation, value-object
- Language: Python
- Homepage: https://pypi.org/project/value-object-pattern/
- Size: 109 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# 📦 Value Object Pattern
The **Value Object Pattern** is a Python 🐍 package that streamlines the creation and management of value objects 📦 in your projects. Value objects are immutable, self-validating objects that represent descriptive aspects of the domain with no conceptual identity. This pattern is essential for maintaining clean 🧹, maintainable, and bug-resistant 🐛 codebases by encapsulating domain-specific logic and ensuring consistency across your application 📱.
## Table of Contents
- [📥 Installation](#installation)
- [🤝 Contributing](#contributing)
- [🔑 License](#license)
## 📥 Installation
You can install **Value Object Pattern** using `pip`:
```bash
pip install value-object-pattern
```
## 🤝 Contributing
We welcome contributions to **Value Object Pattern**! To ensure a smooth collaboration process, please follow the guidelines below.
### How to Contribute
**1. Fork the Repository:** Click the "Fork" button at the top right of the repository page.
**2. Clone Your Fork:**
```bash
git clone git+ssh://[email protected]//value-object-pattern
```
**3. Create a Branch:**
```bash
git checkout -b feature/your-feature-name
```
**4. Make Your Changes:** Implement your new feature or fix a bug.
**5. Run Tests:** Ensure all the following tests pass before submitting your changes.
- Run tests:
```bash
make test
```
- Run tests with coverage:
```bash
make coverage
```
- Run linter:
```bash
make lint
```
- Run formatter:
```bash
make format
```
**6. Commit Your Changes:**
```bash
git commit -m "✨ feature: your feature description"
```
**7. Push to Your Fork:**
```bash
git push origin feature/your-feature-name
```
**8. Create a Pull Request:** Navigate to the original repository and create a pull request from your fork.
**9. Wait for Review:** Your pull request will be reviewed by the maintainers. Make any necessary changes based on their feedback.
## 🔑 License
This project is licensed under the terms of the [`MIT license`](https://github.com/adriamontoto/value-object-pattern/blob/master/LICENSE.md).