Metadata-Version: 2.4
Name: csa_common_lib
Version: 2.4.2
Summary: csa_common_lib is a shared library designed to provide utility modules, class definitions, enumerations, and helper functions for the CSA Prediction Engine Python client. It standardizes and simplifies complex operations across different parts of the CSA Prediction Engine.
Author: Cambridge Sports Analytics
Author-email: prediction@csanalytics.io
Description-Content-Type: text/markdown
Requires-Dist: boto3==1.35.20
Requires-Dist: numpy==2.1.1
Requires-Dist: openpyxl==3.1.5
Requires-Dist: pandas==2.2.2
Requires-Dist: plotnine==0.13.6
Requires-Dist: requests==2.32.3
Dynamic: author
Dynamic: author-email
Dynamic: description
Dynamic: description-content-type
Dynamic: requires-dist
Dynamic: summary

# Cambridge Sports Analytics Common Library

`csa_common_lib` is a shared library that provides utility modules, class definitions, enumerations, and helper functions for the CSA Prediction Engine Python client. It standardizes and simplifies complex operations across the system.

## Installation

Install from PyPI:

```bash
pip install csa-common-lib
```

Requires Python 3.11.

## Package layout

```text
csa_common_lib/
├── classes/
│   ├── float32_encoder.py      # Float32 serialization helpers
│   ├── prediction_options.py   # Prediction, MaxFit, and grid option objects
│   ├── prediction_receipt.py   # Task receipt structures
│   └── prediction_results.py   # Prediction result containers
├── enum_types/
│   ├── errors.py               # Lambda error codes
│   ├── exit_flags.py           # Execution exit flags
│   ├── functions.py            # Function type identifiers
│   ├── job_types.py            # Job routing types
│   ├── lambda_status.py        # Lambda status codes
│   └── results.py              # Result keys and categories
├── helpers/
│   ├── _arrays.py              # Array utilities
│   ├── _conversions.py         # Data conversions
│   ├── _os.py                  # OS helpers
│   └── _vault.py               # Prediction Vault helpers
├── toolbox/
│   ├── _validate.py            # Shared validation helpers
│   ├── _notifier.py            # Notification helpers
│   ├── classes/                # Class-level utilities
│   ├── concurrency/            # Parallel execution helpers
│   ├── database/               # Lightweight DB utilities
│   └── npz/                    # NPZ I/O
└── __init__.py
```

## Usage

Example imports for prediction configuration types:

```python
from csa_common_lib.classes.prediction_options import (
    PredictionOptions,
    MaxFitOptions,
    GridOptions,
)
```

For end-to-end API usage, see the [`csa_prediction_engine`](https://github.com/CambridgeSportsAnalytics/csa_prediction_engine) package.

## Contributing

Bug reports and feature requests are welcome. Reach out to the team at support@csanalytics.io.

## License

Copyright (c) 2023–2026 Cambridge Prediction Analytics, LLC. All rights reserved.
