A Python package for interacting with the Freddy API and other Aitronos services
This project has been archived.
The maintainers of this project have marked this project as archived. No new releases are expected.
Project description
Aitronos Python Package
A Python package for interacting with the Aitronos API, providing both a library interface and a command-line tool.
Installation
From PyPI (Recommended)
pip install aitronos
From Source
git clone https://github.com/Freddy-Development/aitronos-python-package.git
cd aitronos-python-package
pip install -e .
Library Usage
from Aitronos import Aitronos, Message, MessageRequestPayload
# Initialize with API key (recommended)
client = Aitronos(api_key="your_api_key")
# Or with username/password
client = Aitronos(username="your_username", password="your_password")
# Use the assistant messaging
messaging = client.assistant_messaging
response = messaging.execute_run(
MessageRequestPayload(
organization_id=123,
assistant_id=456,
messages=[Message(content="Hello!", role="user")]
)
)
Command Line Interface (CLI)
The Aitronos package includes a powerful CLI for common operations and project management.
Configuration
Before using the CLI, set up your configuration:
- Create a
config.jsonfile in your project root:
{
"test_key": "your_api_key",
"test_org_id": your_organization_id,
"test_assistant_id": your_assistant_id,
"test_username": "your_username",
"test_password": "your_password"
}
- Add
config.jsonto your.gitignoreto keep credentials secure:
echo "config.json" >> .gitignore
Available Commands
- Initialize a new project:
aitronos init my_project
This creates a new project with the following structure:
my_project/
├── config.freddy.json
├── documentation.txt
├── execution_log.json
├── requirements.txt
├── resources/
│ ├── __init__.py
│ ├── current_user.py
│ ├── helpers.py
│ ├── org_data.json
│ └── user_data.json
└── src/
├── main/
│ └── my_project.py
└── tests/
└── test_script.py
- Run the hello world example:
aitronos hello
Tests your setup with a simple hello world example using the Aitronos API.
- Use StreamLine functionality:
# Interactive mode
aitronos streamline
# Process a file
aitronos streamline --input input.txt --output output.txt
Project Templates
When initializing a new project with aitronos init, you get:
- Basic project structure
- Configuration files
- Example code
- Resource templates
- Test setup
The generated project includes:
- Logging setup
- Error handling
- User management
- API integration
- Basic test structure
Development Workflow
- Initialize a new project:
aitronos init my_aitronos_project
cd my_aitronos_project
- Update the configuration:
# Edit config.json with your credentials
vim config.json
- Install project dependencies:
pip install -r requirements.txt
- Start developing:
# Your main code is in src/main/my_aitronos_project.py
# Tests are in src/tests/
Development
To contribute or modify the package:
- Clone the repository:
git clone https://github.com/Freddy-Development/aitronos-python-package.git
cd aitronos-python-package
- Install development dependencies:
pip install -e ".[dev]"
- Run tests:
python -m unittest discover tests
License
This project is licensed under the MIT License - see the LICENSE file for details.
Support
For support, please:
- Open an issue
- Contact us at support@aitronos.com
Security
To report security vulnerabilities, please email security@aitronos.com
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file aitronos-2.1.0.tar.gz.
File metadata
- Download URL: aitronos-2.1.0.tar.gz
- Upload date:
- Size: 5.4 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b3970c09a69c4669caa32c13458af108e30da96a760dee8bfa9d08727b31f94b
|
|
| MD5 |
d1e5ffe73b3559052f93d72e5d577a39
|
|
| BLAKE2b-256 |
29911a3fbb45ecacfe9e787aaef707a8af57811a36b6b7a2940bb8bc091ea7d5
|
File details
Details for the file aitronos-2.1.0-py3-none-any.whl.
File metadata
- Download URL: aitronos-2.1.0-py3-none-any.whl
- Upload date:
- Size: 6.5 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e4d121d5e8e4bd7e5289683090a3b18ec16e7e7bb911f78d1fa8a7170b93c450
|
|
| MD5 |
a1f1336df07ebdf0b8c61d9de0e8ae8a
|
|
| BLAKE2b-256 |
30f29cbf3ae45fa34a551d73391b2c139da8b1b66575df5de4ac9bd32a0a16e8
|