Core-Lib Folder Structure

Note: Generated Core-Libs will adopt the same folder structure. Following the same across all of your Core-Libs make it dive right into an existing project.

    
    core_lib # Core-Lib Project Directory
    └───  core_lib # Core-Lib Main Code Directory
    |       └─── config
    |       |       └─── core_lib.yaml
    |       └─── data_layers
    |       |        └─── data # store all connector, definition, mapping to data sources
    |       |        |      └─── db # store database ORM entities
    |       |        |      |     └─── migrations # database migration scripts
    |       |        |      └─── elastic # store elastic search base classes
    |       |        |      └─── mongo # store mongo base classes
    |       |        └─── data access # expose API that uses data layer
    |       |        |	    └─── user # group user data access
    |       |        |	    |    └─── user_data_access.py
    |       |        |	    |    └─── user_list_data_access.py
    |       |        |	    └─── some_data_access.py
    |       |        └─── service # expost the core-lib services
    |       |               └─── user # group user services
    |       |               |    └─── user_service.py
    |       |        	    |    └─── user_list_service.py
    |       |        	    └─── some_service.py
    |       └─── jobs # jobs definitions
    |       |	  └─── update_something_job.py
    |       |	  └─── another_job.py
    |       └─── client # client definitions
    |       |	  └─── server_a_client.py
    |       |	  └─── another_client.py
    |       └─── app_core_lib.py # Main Core-Lib file that glows the entire library 
    └─── tests # Unit test the entire data_layers
     	 └─── config # config file for the tests
    

Core-Lib Project Directory:

This root directory serves as the foundational structure for the Core-lib project, encompassing all its project code and resources. It is a standard way to manage any Python project. Here, developers can find the core files and directories essential for building, configuring, and extending the functionality of the Core-lib.

Core-Lib Main Code Directory:

This directory contains the main source code and modules of Core-lib, serving as the heart of the library. Developers will find key Python files and subdirectories containing the core functionalities and implementations that power the Core-lib framework.

Tests:

This directory contains the unit tests for Core-lib, allowing developers to verify the correctness and integrity of the library’s functionalities. It includes test cases and configurations necessary for testing various components and features of the Core-lib framework.

Config:

This directory contains your Core-lib configuration file crucial for configuring and customizing Core-lib to suit specific requirements.

Core.lib.yaml:

A main configuration file containing settings specific to Core-lib, facilitating easy customization and configuration of core functionalities.

Data Layers:

This directory manages the core data layers of the library, responsible for handling data interactions and management.

Data:

Within the Data Layers directory, this serves as a subdirectory where various components related to different data sources and their interactions are organized.

• db:

  Stores components related to database interactions, including ORM entities and migration scripts necessary for schema modifications.

  • Migrations:

    A repository for database migration scripts, crucial for managing schema changes and updates in database systems.

• Elastic:

  Contains base classes and utilities for interacting with Elasticsearch, facilitating efficient data retrieval and indexing operations.

• Mongo:

  Hosts base classes and utilities for MongoDB interactions, ensuring smooth handling of NoSQL database operations.

Data_access:

Within the Data Layers directory, this directory exposes APIs responsible for interacting with the data layer, promoting efficient data retrieval and manipulation.

• User:

  A dedicated module for user data access, providing methods for accessing and manipulating user-related data efficiently.

  • user_data_access.py:

    Implements methods for accessing and manipulating user data, ensuring streamlined user-related operations.

  • user_list_data_access.py:

    Facilitates batch operations and data retrieval for user lists, enhancing scalability and performance.

• some_data_access.py:

  An example module demonstrating data access for other entities or functionalities within the Core-lib.

Service:

This directory exposes essential services provided by the Core-lib, encapsulating core functionalities and business logic.

• User:

  Contains service modules focused on user-related functionalities and operations.

  • user_service.py:

    Implements user-related services such as user authentication, authorization, and profile management.

  • user_list_service.py:

    Provides services for managing user lists and performing batch operations efficiently.

• some_service.py:

  Demonstrates service functionalities for other core components or functionalities.

Jobs:

Hosts definitions for background tasks or scheduled operations, crucial for maintaining system integrity and performance.

• update_something_job.py:

  Represents a job definition responsible for executing periodic updates or maintenance tasks within the system.

• another_job.py:

  Another example job definition highlighting diverse functionalities or tasks handled by the Core-lib.

Client:

Contains client definitions facilitating interactions with external services, servers, or APIs.

• server_a_client.py:

  Represents a client definition tailored for interacting with Server A, encapsulating communication protocols and data exchange mechanisms.

• another_client.py:

  Another client definition catering to interactions with a different external service or system.

app_core_lib.py:

This main Core-lib file serves as the entry point for the entire library, orchestrating interactions between various components and providing essential functionalities to external modules or applications.