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 layered_py.service import Service
from layered_py.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 layered_py.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 layered_py.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-2.0.0.tar.gz (6.7 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-2.0.0-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for layered_py-2.0.0.tar.gz
Algorithm Hash digest
SHA256 8c57ab4cd40c194e33a964a8f55309f9335dfb62e0812555044ea6d75ed7ad68
MD5 70da22ea833c60eac52f3ae74860343b
BLAKE2b-256 add652ec5dfaf5f31a648e48bd8411d3dcb869d9e49d9975978990254c3c599d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: layered_py-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 7.5 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-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1a93a4800b967969532768eabf4f7c7c51d28564aa211657a079f51078e502fe
MD5 0f2a25fc5367646594fb1ca3a125adea
BLAKE2b-256 e644df589f7078584a74a1f5fb674f566b7d0e96340fc3f18ca834db7c1a4d08

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