auris_tools 0.1.0

The swiss knife tools to coordinates cloud frameworks with an easy for Auris platforms

auris-tools

The swiss knife tools to coordinates cloud frameworks with an easy for Auris platforms

Installation

This project requires Python 3.10 and uses Poetry for dependency management.

1. Clone the repository:

   git clone https://github.com/AurisAASI/auris-tools.git
   cd auris-tools
   

2. Install Poetry (if not already installed):

   pip install poetry
   

3. Install dependencies:

   poetry install
   

---

Project Structure

The main classes and modules are organized as follows:

/auris_tools
├── __init__.py
├── configuration.py         # AWS configuration utilities
├── databaseHandlers.py      # DynamoDB handler class
├── officeWordHandler.py     # Office Word document handler
├── storageHandler.py        # AWS S3 storage handler
├── textractHandler.py       # AWS Textract handler
├── utils.py                 # Utility functions
├── geminiHandler.py         # Google Gemini AI handler

---

Testing & Linting

• Run all tests:

  task test
  

• Run linter (blue and isort):

  task lint
  

Test coverage and linting are enforced in CI. Make sure all tests pass and code is linted before submitting a PR.

Documentation

We use MkDocs with Material theme for our documentation:

• Run documentation server locally:

  task docs
  

• Build documentation:

  task docs-build
  

The documentation is automatically published to Read the Docs when changes are pushed to the main branch.

---