Metadata-Version: 2.4
Name: guidelight
Version: 0.5.0
Summary: A library for developing task-oriented AI systems that integrate with Endeavor.
Home-page: https://github.com/rotationalio/guidelight
Download-URL: https://github.com/rotationalio/guidelight/tarball/v0.5.0
Author: Rotational Labs
Author-email: support@rotational.io
Maintainer: Rotational Labs
Maintainer-email: support@rotational.io
License: BSD 3-Clause
Project-URL: Documentation, https://github.com/rotationalio/guidelight
Project-URL: Download, https://github.com/rotationalio/guidelight/tarball/v0.5.0
Project-URL: Source, https://github.com/rotationalio/guidelight
Project-URL: Tracker, https://github.com/rotationalio/guidelight/issues
Keywords: guidelight,ai,endeavor,api client,tasks,workflows
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10, <4
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pydantic==2.13.5
Requires-Dist: PyJWT==2.10.1
Requires-Dist: python-dotenv==1.1.1
Requires-Dist: requests==2.32.5
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: download-url
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: maintainer
Dynamic: maintainer-email
Dynamic: project-url
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# Guidelight

Guidelight is a Python SDK for building, evaluating, releasing, and running
task-oriented AI systems on Endeavor.

## Install

```console
pip install guidelight
```

## Configure

Set an Endeavor URL and API-key credentials in the environment or a local
`.env` file:

```dotenv
ENDEAVOR_URL=https://example.test
ENDEAVOR_AUTH_URL=https://auth.example.test
ENDEAVOR_CLIENT_ID=example-client-id
ENDEAVOR_CLIENT_SECRET=example-client-secret
```

`ENDEAVOR_AUTH_URL` is optional when authentication uses the same origin as
`ENDEAVOR_URL`. Set it when the authentication service uses another origin.

## Connect and list Agents

```python
import guidelight as gdl

endeavor = gdl.connect()

for agent in endeavor.agents.list(page_size=10):
    print(agent.name)
```

Resource managers return typed models:

```python
from guidelight.models import Agent

agent: Agent = endeavor.agents.get("atlas-assistant")
print(agent.id, agent.slug)
```

Use `guidelight.client()` when direct low-level endpoint access is needed.

## Run a deployed Task

```python
result = endeavor.run(
    "atlas-assistant",
    "summarize-note",
    context={"note": "A fictional project update."},
)
```



## Documentation

- [Documentation home](docs/README.md)
- [Getting started](docs/getting-started.md)
- [Core concepts](docs/concepts.md)
- [Executing deployed Tasks](docs/execution.md)
- [Resource lifecycle](docs/lifecycle.md)
- [Low-level client](docs/client.md)
- [Resource reference](docs/resources/README.md)

