semvec/pypi-packages huggingface dataset:
jobbergate-cli 5.10.0a1
Jobbergate CLI Client
License: MIT
Requires Python: >=3.10

# Jobbergate CLI

The Jobbergate CLI provides a command-line interface to view and manage the Jobbergate
resources. It can be used to create Job Scripts from template and then submit them to
the Slurm cluster to which Jobbergate is connected.

Jobbergate CLI is a Python project implemented with the
[Typer](https://typer.tiangolo.com/) CLI builder library. Its dependencies and
environment are managed by [uv](https://docs.astral.sh/uv/).

The CLI has a rich help system that can be accessed by passing the `--help` flag to
the main command:

```shell
jobbergate job-scripts --help
```

There is also help and parameter guides for each of the subcommands that can be accessed
by passing them the `--help` flag:

```shell
jobbergate job-scripts list --help
```

See also:

* [jobbergate-api](https://github.com/omnivector-solutions/jobbergate/jobbergate-api)

## License

* [MIT](./LICENSE)

## Copyright

* Copyright (c) 2020 OmniVector Solutions <info@omnivector.solutions>
jobbergate-api 5.10.0a1
Jobbergate API
License: MIT
Requires Python: >=3.12

# Jobbergate API

The Jobbergate API provides a RESTful interface over the Jobbergate data and is used
by both the `jobbergate-agent` and the `jobbergate-cli` to view and manage the
Jobbergate resources.

Jobbergate API is a Python project implemented with
[FastAPI](https://fastapi.tiangolo.com/). Its dependencies and environment are
managed by [uv](https://docs.astral.sh/uv/).

It integrates with an OIDC server to provide identity and auth for its endpoints.

See also:

* [jobbergate-cli](https://github.com/omnivector-solutions/jobbergate/jobbergate-cli)

## License

* [MIT](./LICENSE)

## Copyright

* Copyright (c) 2020 OmniVector Solutions <info@omnivector.solutions>
jobbergate-agent 5.10.0a1
Jobbergate Agent
License: MIT
Requires Python: >=3.10

# 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 [uv](https://docs.astral.sh/uv/). 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`.
jobbergate-core 5.10.0a1
Jobbergate Core
License: MIT
Requires Python: >=3.10

# Jobbergate Core

Jobbergate-core is a sub-project that contains the key components and logic that is shared among all other sub-projects
(CLI, API, and Agent). Additionally, jobbergate-core exists to support custom automation built on top of Jobbergate.

## License

* [MIT](LICENSE)

## Copyright

* Copyright (c) 2023 OmniVector Solutions <info@omnivector.solutions>