Metadata-Version: 2.4
Name: bclearer-orchestration-services
Version: 0.7.0
Summary: A set of orchestration services for the bclearer framework, covering application running, logging, reporting, identity generation, static code analysis, and version control.
Project-URL: Homepage, https://github.com/ontoledgy-labs/bclearer
Project-URL: Source, https://github.com/ontoledgy-labs/bclearer/tree/main/libraries/orchestration_services
Project-URL: Documentation, https://github.com/ontoledgy-labs/bclearer/blob/main/libraries/orchestration_services/README.md
Project-URL: Issues, https://github.com/ontoledgy-labs/bclearer/issues
Project-URL: Changelog, https://github.com/ontoledgy-labs/bclearer/blob/main/libraries/orchestration_services/CHANGELOG.md
Author-email: Mesbah Khan <support@ontoledgy.io>
License-Expression: AGPL-3.0-or-later
License-File: LICENSE.md
Requires-Python: >=3.12
Requires-Dist: bclearer-core<0.9.0,>=0.8.0
Requires-Dist: bclearer-interop-services<0.15.0,>=0.14.0
Requires-Dist: blake3
Requires-Dist: gitpython
Requires-Dist: networkx
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: picologging
Requires-Dist: psutil
Requires-Dist: setuptools
Provides-Extra: static-analysis
Requires-Dist: pylint; extra == 'static-analysis'
Requires-Dist: radon; extra == 'static-analysis'
Provides-Extra: telegram
Requires-Dist: telethon; extra == 'telegram'
Provides-Extra: web
Requires-Dist: fastapi; extra == 'web'
Requires-Dist: flask; extra == 'web'
Requires-Dist: python-multipart>=0.0.31; extra == 'web'
Requires-Dist: uvicorn; extra == 'web'
Provides-Extra: windows
Requires-Dist: msaccessdb; (platform_system == 'Windows') and extra == 'windows'
Requires-Dist: pywin32; (platform_system == 'Windows') and extra == 'windows'
Description-Content-Type: text/markdown

# bclearer-orchestration-services

Welcome to the `bclearer_orchestration_services` package, a part of the bCLEARer™ framework, which is designed to support semantic engineering and data pipeline architecture. This package provides orchestration services essential for the execution, control, and management of the bCLEARer framework's core processes.

## Overview

The `bclearer_orchestration_services` package is built to handle various utilities and services required for orchestrating tasks within the bCLEARer framework. It includes a variety of modules, each serving a specific purpose within the orchestration pipeline, ensuring flexibility, modularity, and scalability.

## Structure

The package is organized into several modules:

- **b_app_runner_service**: Manages the execution of bCLEARer applications and processes.
- **b_eng_python_refactoring_service**: Provides utilities to refactor and enhance Python code as part of the engineering pipeline.
- **bclearer_load_service**: Handles the loading and transformation of data into the bCLEARer framework.
- **datetime_service**: Offers utilities for handling date and time operations.
- **identification_services**: Manages identity creation and tracking within the data pipeline.
- **log_environment_utility_service**: Utilities for managing and standardizing log environments across various processes.
- **reporting_service**: Creates reports based on the orchestration of tasks.
- **static_code_analysis_service**: Provides static analysis of code for validation and best practices.
- **string_service**: Utilities for advanced string manipulation and transformations.
- **unicode_service**: Handles operations related to Unicode data.
- **unit_of_measure_services**: Deals with standardization and management of units of measure within the pipeline.
- **version_control_services**: Manages versioning of data, processes, and code in the orchestration.

## Installation

To install this package, use pip:

```bash
pip install bclearer-orchestration-services
```

Or, clone this repository and install it locally:

```bash
git clone https://github.com/ontoledgy-labs/bclearer.git
cd bclearer/libraries/orchestration_services
pip install .
```

## Usage

To use the services in this package, you can import individual modules according to your needs. For example:

```python
from bclearer_orchestration_services import b_app_runner_service

# Example usage
runner = b_app_runner_service.AppRunner()
runner.run_application(app_name="example_app")
```

## Contributing

Issues and feedback are welcome. Code pull requests are not being accepted yet, so please raise anything you find as an issue rather than as a patch.

For anything that does not fit an issue, contact support@ontoledgy.io.

## Licence

This project is licensed under the GNU Affero General Public License v3.0 or later (AGPL-3.0-or-later). See the [LICENSE](https://github.com/ontoledgy-labs/bclearer/blob/main/LICENSE) file for the full text.

Commercial licences are available for organisations that cannot comply with the AGPL's network-use and source-disclosure terms. Contact support@ontoledgy.io for details.
