Metadata-Version: 2.1
Name: gllm-core-binary
Version: 0.3.3
Summary: A library containing core components for Gen AI applications.
Author: Dimitrij Ray
Author-email: dimitrij.ray@gdplabs.id
Requires-Python: >=3.11,<3.14
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: colorama (>=0.4.6,<0.5.0)
Requires-Dist: deprecation (>=2.1.0,<3.0.0)
Requires-Dist: google (>=3.0.0,<4.0.0)
Requires-Dist: google-auth (>=2.38.0,<3.0.0)
Requires-Dist: gspread (>=6.1.4,<7.0.0)
Requires-Dist: numpy (>=1.26,<2.0) ; python_version < "3.12"
Requires-Dist: numpy (>=1.26,<3) ; python_version >= "3.12" and python_version < "3.13"
Requires-Dist: numpy (>=2.2,<3.0) ; python_version >= "3.13"
Requires-Dist: poetry (>=2.1.3,<3.0.0)
Requires-Dist: pydantic (>=2.11.4,<3.0.0)
Requires-Dist: scipy (>=1.15.1,<2.0.0)
Requires-Dist: virtualenv (==20.30.0)
Description-Content-Type: text/markdown

# GLLM Core

## Description

A core library providing foundational components and utilities for Generative AI applications.

## Installation

### Prerequisites
- Python 3.11+ - [Install here](https://www.python.org/downloads/)
- Pip (if using Pip) - [Install here](https://pip.pypa.io/en/stable/installation/)
- Poetry 1.8.1+ (if using Poetry) - [Install here](https://python-poetry.org/docs/#installation)
- Git (if using Git) - [Install here](https://git-scm.com/downloads)
- For git installation:
  - Access to the [GDP Labs SDK github repository](https://github.com/GDP-ADMIN/gen-ai-internal)

### 1. Installation from Artifact Registry
Choose one of the following methods to install the package:

#### Using pip
```bash
pip install gllm-core-binary
```

#### Using Poetry
```bash
poetry add gllm-core-binary
```

### 2. Development Installation (Git)
For development purposes, you can install directly from the Git repository:
```bash
poetry add "git+ssh://git@github.com/GDP-ADMIN/gen-ai-internal.git#subdirectory=libs/gllm-core"
```

## Managing Dependencies
1. Go to root folder of `gllm-core` module, e.g. `cd libs/gllm-core`.
2. Run `poetry shell` to create a virtual environment.
3. Run `poetry lock` to create a lock file if you haven't done it yet.
4. Run `poetry install` to install the `gllm-core` requirements for the first time.
5. Run `poetry update` if you update any dependency module version at `pyproject.toml`.

## Contributing
Please refer to this [Python Style Guide](https://docs.google.com/document/d/1uRggCrHnVfDPBnG641FyQBwUwLoFw0kTzNqRm92vUwM/edit?usp=sharing)
to get information about code style, documentation standard, and SCA that you need to use when contributing to this project

1. Activate `pre-commit` hooks using `pre-commit install`
2. Run `poetry shell` to create a virtual environment.
3. Run `poetry lock` to create a lock file if you haven't done it yet.
4. Run `poetry install` to install the `gllm-core` requirements for the first time.
5. Run `which python` to get the path to be referenced at Visual Studio Code interpreter path (`Ctrl`+`Shift`+`P` or `Cmd`+`Shift`+`P`)
6. Try running the unit test to see if it's working:
```bash
poetry run pytest -s tests/unit_tests/
```

