Skip to main content

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

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

layered_py-1.0.2.tar.gz (3.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

layered_py-1.0.2-py3-none-any.whl (4.3 kB view details)

Uploaded Python 3

File details

Details for the file layered_py-1.0.2.tar.gz.

File metadata

  • Download URL: layered_py-1.0.2.tar.gz
  • Upload date:
  • Size: 3.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.2

File hashes

Hashes for layered_py-1.0.2.tar.gz
Algorithm Hash digest
SHA256 2382d9a6af215854e307562bc9a6b2dc7a104f9f35b4140c6088cc5eea910f60
MD5 de4cbded941698f41f21ae00119cf49d
BLAKE2b-256 3a1fefa9396da8b3ab568321cafc42fb19ce372d481ee167ce6bcefe15195ea5

See more details on using hashes here.

File details

Details for the file layered_py-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: layered_py-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 4.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.2

File hashes

Hashes for layered_py-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ed86da71ff75f5ef89bf33645d7f469cdd22cb86a39034650be02528424753bd
MD5 d4d61b94980454d896a86470a1f1f7a5
BLAKE2b-256 0cd194d1a6117d5eaf0e964dbf3b370b541f1013532f343fb6b29d5b76a9fec8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page