layered-py 1.0.0

A Python library for implementing layered architecture with services and dependency injection.

LayeredPy

LayeredPy is a Python library built to implement a clean, maintainable layered architecture. It offers support for service-oriented programming and includes built-in dependency injection (DI) to improve code modularity and testability.

---

Features

• Layered Architecture: Enables a structured and modular separation of concerns.
• Dependency Injection: Dependencies get injected automatically, improving testability and reducing tight coupling.
• Service Management: Defines base services with extensible behavior for your application logic.
• CLI Tool: Generate service boilerplate with the service tool.

---

Installation

Install LayeredPy using pip:

pip install layered-py

---

Getting Started

Here’s how you can use LayeredPy in your projects.

---

1. Define and Register a Service

Create a service by subclassing the Service class and use the @register_service decorator to register it.

from service_layer.service import Service
from service_layer.decorators import register_service

@register_service("GreetingService")
class GreetingService(Service):
    def say_hello(self):
        print("Hello from LayeredPy!")

---

2. Inject the Service Where Needed

With the @inject decorator, services can be directly injected as attributes of the class. You don’t need to pass them explicitly.

from service_layer.decorators import inject

class MyApp:
    @inject("GreetingService")
    def run(self):
        self.GreetingService.say_hello()  # Directly access the injected service

# Example usage
if __name__ == "__main__":
    app = MyApp()
    app.run()

Output:

Hello from LayeredPy!

---

3. Generate Service Templates with the CLI

You can use the built-in service CLI tool to create new service boilerplates automatically.

Example Usage:

service create MyNewService

This command generates the following services/MyNewService.py file:

from service_layer.service import Service

class MyNewService(Service):
    def setup(self):
        pass

    def handle(self):
        raise NotImplementedError

License

This project is licensed under the MIT License.

---

Support

For questions or support, feel free to open an issue on the GitHub Issues page. You can find more information on the project repository.