GithubHelp home page GithubHelp logo

Comments (1)

cdddg avatar cdddg commented on June 16, 2024

Following the title, what would be the integrated project structure?

Project Structure Adjustment

  • Objective: Enhance maintainability and scalability.
  • Approach: Modularize components into sdk and workers directories.

SDK Integration

  • Purpose: Synchronize SDK updates with API changes, ensuring consistency.
  • Structure:
    • sdk/ directory under src/ for client logic, data models, and exceptions.
  • Reason: Facilitates SDK's close collaboration with the main project and simplifies data model sharing.

Workers Integration

  • Purpose: To seamlessly incorporate background tasks, such as Celery tasks and message queue (MQ) consumers, utilizing the logic from the use case layer.
  • Structure:
    • workers/ directory under src/ is designated for configurations, task definitions, and scripts for MQ consumers.
  • Advantages:
    • Flexibility: This structure allows for easy addition, modification, and removal of background tasks as the project evolves.
    • Scalability: It supports scaling the processing of background tasks independently from the main application, facilitating efficient handling of varying workloads.
  • Reason: Centralizing the management of background tasks not only streamlines the project organization but also enhances the ability to handle complex workflows and asynchronous operations, improving overall project performance and maintainability.

Example

./
├── src/
│   ├── di/
│   ├── entrypoints/
│   ├── usecases/
│   ├── models/
│   ├── repositories/
│   ├── common/
│   ├── settings/
│   │
│   ├── workers/                  - Configuration and scripts for background tasks and consumers.
│   │   ├── celery_engine/        - Contains Celery beat and worker configurations. 
│   │   │                         - (Other suggested names: celery_hub, celery_workers, task_scheduler)
│   │   └── mq_consumer/          - Message queue consumer scripts.
│   │
│   ├── sdk/                      - Toolkit for interfacing with the API via HTTPX, returning function calls as project entities.
│   │   └── aio/client.py         - Asynchronous client implementation.
│   │
│   └── main.py                   - Main file to start the application.
└── tests/

from py-clean-arch.

Related Issues (3)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.