Metadata-Version: 2.1
Name: jobbergate-agent
Version: 5.5.0a4
Summary: Jobbergate Agent
Home-page: https://github.com/omnivector-solutions/jobbergate
License: MIT
Author: Omnivector Solutions
Author-email: info@omnivector.solutions
Requires-Python: >=3.10,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Scientific/Engineering
Requires-Dist: apscheduler (==3.10.3)
Requires-Dist: auto-name-enum (>=2.0.0,<3.0.0)
Requires-Dist: httpx (==0.24.1)
Requires-Dist: importlib-metadata (>=6.8.0,<7.0.0) ; python_version < "3.10"
Requires-Dist: influxdb (>=5.3.2,<6.0.0)
Requires-Dist: jobbergate-core (==5.5.0-alpha.4)
Requires-Dist: loguru (==0.6.0)
Requires-Dist: msgpack (>=1.1.0,<2.0.0)
Requires-Dist: numba (>=0.60.0,<0.61.0)
Requires-Dist: py-buzz (>=4.0.0,<5.0.0)
Requires-Dist: pydantic (>=2.7,<3.0)
Requires-Dist: pydantic-settings (>=2.3.3,<3.0.0)
Requires-Dist: pyjwt (>=2.8.0,<3.0.0)
Requires-Dist: python-dotenv (>=1.0.0,<2.0.0)
Requires-Dist: python-jose (==3.3.0)
Requires-Dist: sentry-sdk (>=1.1.0,<2.0.0)
Project-URL: Bug Tracker, https://github.com/omnivector-solutions/jobbergate/issues
Project-URL: Changelog, https://github.com/omnivector-solutions/jobbergate/blob/main/jobbergate-agent/CHANGELOG.rst
Project-URL: Repository, https://github.com/omnivector-solutions/jobbergate
Description-Content-Type: text/markdown

# Jobbergate-agent

## Install the package

To install the package from Pypi simply run `pip install jobbergate-agent`.

## Setup parameters

1. Setup dependencies

    Dependencies and environment are managed in the project by [Poetry](https://python-poetry.org/). To initiate the development environment run:

    ```bash
    make install
    ```

2. Setup `.env` parameters

    ```bash
    JOBBERGATE_AGENT_BASE_API_URL="<base-api-url>"
    JOBBERGATE_AGENT_X_SLURM_USER_NAME="<sbatch-user-name>"
    JOBBERGATE_AGENT_SENTRY_DSN="<sentry-dsn-key>"
    JOBBERGATE_AGENT_OIDC_DOMAIN="<OIDC-domain>"
    JOBBERGATE_AGENT_OIDC_CLIENT_ID="<OIDC-app-client-id>"
    JOBBERGATE_AGENT_OIDC_CLIENT_SECRET="<OIDC-app-client-secret>"
    ```

    **Note**: `JOBBERGATE_AGENT_SENTRY_DSN` is optional. If you do not pass it the agent understands Sentry will not be used.

## Local usage example

1. Run app

    ```bash
    jg-run
    ```

    **Note**: this command assumes you're inside a virtual environment in which the package is installed.

    **Note**: beware you should care about having the same user name you're using to run the code in the slurmctld node. For example, if `cluster_agent` will run the `make run` command then the slurmctld node also must have a user called `cluster_agent`.

