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-1.0.3.tar.gz (4.3 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.3-py3-none-any.whl (5.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: layered_py-1.0.3.tar.gz
  • Upload date:
  • Size: 4.3 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.3.tar.gz
Algorithm Hash digest
SHA256 742892bf08c83a4d67137fc65da89277e919db31d61d0f1333703b14931cf529
MD5 5abfefdcbd71a02b06292e69e591605f
BLAKE2b-256 e718c0e9d55459926fc5caeabbe46946d14e62f59a2b1a5c412592cfefc134b1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: layered_py-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 5.4 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a4a37acab8de2f70a2fde801d12888834a4f239e8ce72c74bcf25e0dc730cffb
MD5 e013ab3af53411fb0bd191d82cbc3748
BLAKE2b-256 702b0e0e08c38cbbae11c58f9542026b2e68bf303c7e32716ea7ca6f062376f7

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