Skip to main content

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:

  1. Create a config.json file 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"
}
  1. Add config.json to your .gitignore to keep credentials secure:
echo "config.json" >> .gitignore

Available Commands

  1. 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
  1. Run the hello world example:
aitronos hello

Tests your setup with a simple hello world example using the Aitronos API.

  1. 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

  1. Initialize a new project:
aitronos init my_aitronos_project
cd my_aitronos_project
  1. Update the configuration:
# Edit config.json with your credentials
vim config.json
  1. Install project dependencies:
pip install -r requirements.txt
  1. 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:

  1. Clone the repository:
git clone https://github.com/Freddy-Development/aitronos-python-package.git
cd aitronos-python-package
  1. Install development dependencies:
pip install -e ".[dev]"
  1. 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:

Security

To report security vulnerabilities, please email security@aitronos.com

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aitronos-2.0.3.tar.gz (2.7 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aitronos-2.0.3-py3-none-any.whl (3.2 MB view details)

Uploaded Python 3

File details

Details for the file aitronos-2.0.3.tar.gz.

File metadata

  • Download URL: aitronos-2.0.3.tar.gz
  • Upload date:
  • Size: 2.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.5

File hashes

Hashes for aitronos-2.0.3.tar.gz
Algorithm Hash digest
SHA256 f151854337c31794d0ae96e53a330b3571405b748a8ef072345584b5f829042b
MD5 1525bd2e6d3379891e9ec153c30a19d1
BLAKE2b-256 b57a778de8401899126d6850acb43cb3156292bc254bc0df9006d90250478076

See more details on using hashes here.

File details

Details for the file aitronos-2.0.3-py3-none-any.whl.

File metadata

  • Download URL: aitronos-2.0.3-py3-none-any.whl
  • Upload date:
  • Size: 3.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.5

File hashes

Hashes for aitronos-2.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 f6c2745035f11944a539155f8a61d80af88805d5df81c3ee890caf7588be3685
MD5 01b5d061f2fa8e587593e3f25ad1f382
BLAKE2b-256 4fb56d8bea703de24e4a2f9d60245fc021df2811ff0b5c8866be7bdabb79a15e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page