underpyx 0.3.1

Fundamental utilities in python, such as encapsulation, immutability, service patterns, and JSON type hinting.

underpy 🐍

Reusable Python base classes for clean, maintainable, and scalable projects.
Underpy provides foundational building blocks such as encapsulated data, immutable objects, service patterns, and JSON typing — so you can start every new project with a solid, consistent architecture.

---

✨ Features

• Encapsulated – Hide internals and expose clean public APIs
• Immutable – Prevent changes to objects after initialization
• Service Class (Singleton) – Enforce a single point of access for core services
• JSON Type – Typed JSON data handling made easy
• Tested with Pytest + AssertPy – Reliable and expressive tests

---

📦 Installation

Install from source:

pip install git+https://github.com/ariana126/underpy.git

or PyPI

pip install underpyx

---

🚀 Quick Start

Example: Encapsulated

from underpy import Encapsulated

class User(Encapsulated):
    def __init__(self, username):
        self._username = username

    def get_username(self):
        return self._username

user = User("ariana")
print(user.get_username())  # ✅ "ariana"
# Direct access is avoided: user._username

---

Example: Immutable

from underpy import Immutable

class Config(Immutable):
    def __init__(self, host, port):
        self.host = host
        self.port = port

cfg = Config("localhost", 8080)
# cfg.port = 9000  # ❌ Raises AttributeError

---

🧪 Running Tests

pytest

---

📄 License

This project is licensed under the MIT License – see the LICENSE file for details.

---

🤝 Contributing

Contributions are welcome!
If you have an improvement or find a bug:

1. Fork the repo
2. Create your branch
3. Submit a pull request

---

💡 About

This project is part of a personal utility toolkit used to maintain a consistent, clean architecture across Python projects.
Originally authored by Ariana.