Metadata-Version: 2.1
Name: alumnium
Version: 0.5.0
Summary: Pave the way towards AI-powered test automation.
Home-page: https://alumnium.ai
License: MIT
Author: Alex Rodionov
Author-email: p0deje@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: langchain (>=0.3,<0.4)
Requires-Dist: langchain-anthropic (>=0.2,<0.3)
Requires-Dist: langchain-aws (>=0.2.7,<0.3.0)
Requires-Dist: langchain-google-genai (>=2.0,<3.0)
Requires-Dist: langchain-openai (>=0.2,<0.3)
Requires-Dist: retry2 (>=0.9,<0.10)
Requires-Dist: selenium (>=4.0,<5.0)
Project-URL: Repository, https://github.com/alumnium-hq/alumnium
Description-Content-Type: text/markdown

<h1>
    <p align="center">
        <img src="https://github.com/user-attachments/assets/44e63cc3-d0e8-4b79-bfc1-015ce91a92f7" height="128" alt="Logo" />
        <br />
        Alumnium
    </p>
</h1>
<p align="center">
    Pave the way towards AI-powered test automation.
    <br />
    <a href="#installation">Installation</a>
    ·
    <a href="#quick-start">Quick Start</a>
    ·
    <a href="https://alumnium.ai/docs/">Documentation</a>
</p>

Aluminum is an experimental project that builds upon the existing test automation ecosystem, offering a higher-level abstraction for testing. It aims to simplify interactions with web pages and provide more robust mechanisms for verifying assertions.

<img src="https://raw.githubusercontent.com/alumnium-hq/alumnium.github.io/ccc7886dcf325d7b34d349facec7393d18812054/src/assets/overview.gif" height="auto" width="620px" />

Currently in the very early stages of development and not recommended for production use.

## Installation

```bash
pip install alumnium
```

## Quick Start

```python
import os
from alumnium import Alumni
from selenium.webdriver import Chrome

os.environ["OPENAI_API_KEY"] = "..."

driver = Chrome()
driver.get("https://google.com")

al = Alumni(driver)
al.do("search for selenium")
al.check("selenium in page title")
al.check("selenium.dev is present in the search results")
```

Check out [documentation][1] and more [examples][2]!

## Development

Setup the project:

```bash
pipx install poetry
poetry install
```

Configure access to [AI providers][3] and start hacking!

Useful commands during development:

```bash
poetry run python -i demo.py  # run REPL
poetry run behave             # run Gherkin examples
poetry run pytest             # run Pytest examples
```



[1]: https://alumnium.ai/docs/
[2]: examples/
[3]: https://alumnium.ai/docs/getting-started/configuration/

