Metadata-Version: 2.1
Name: coaiapy
Version: 0.2.19
Summary: A Python package for audio transcription, synthesis, and tagging using Boto3.
Home-page: https://github.com/jgwill/coaiapy
Author: Jean GUillaume ISabelle
Author-email: Jean GUillaume ISabelle <jgi@jgwill.com>
License: Creative Commons Legal Code
        
        CC0 1.0 Universal
        
            CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
            LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
            ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
            INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
            REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
            PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
            THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
            HEREUNDER.
        
        Statement of Purpose
        
        The laws of most jurisdictions throughout the world automatically confer
        exclusive Copyright and Related Rights (defined below) upon the creator
        and subsequent owner(s) (each and all, an "owner") of an original work of
        authorship and/or a database (each, a "Work").
        
        Certain owners wish to permanently relinquish those rights to a Work for
        the purpose of contributing to a commons of creative, cultural and
        scientific works ("Commons") that the public can reliably and without fear
        of later claims of infringement build upon, modify, incorporate in other
        works, reuse and redistribute as freely as possible in any form whatsoever
        and for any purposes, including without limitation commercial purposes.
        These owners may contribute to the Commons to promote the ideal of a free
        culture and the further production of creative, cultural and scientific
        works, or to gain reputation or greater distribution for their Work in
        part through the use and efforts of others.
        
        For these and/or other purposes and motivations, and without any
        expectation of additional consideration or compensation, the person
        associating CC0 with a Work (the "Affirmer"), to the extent that he or she
        is an owner of Copyright and Related Rights in the Work, voluntarily
        elects to apply CC0 to the Work and publicly distribute the Work under its
        terms, with knowledge of his or her Copyright and Related Rights in the
        Work and the meaning and intended legal effect of CC0 on those rights.
        
        1. Copyright and Related Rights. A Work made available under CC0 may be
        protected by copyright and related or neighboring rights ("Copyright and
        Related Rights"). Copyright and Related Rights include, but are not
        limited to, the following:
        
          i. the right to reproduce, adapt, distribute, perform, display,
             communicate, and translate a Work;
         ii. moral rights retained by the original author(s) and/or performer(s);
        iii. publicity and privacy rights pertaining to a person's image or
             likeness depicted in a Work;
         iv. rights protecting against unfair competition in regards to a Work,
             subject to the limitations in paragraph 4(a), below;
          v. rights protecting the extraction, dissemination, use and reuse of data
             in a Work;
         vi. database rights (such as those arising under Directive 96/9/EC of the
             European Parliament and of the Council of 11 March 1996 on the legal
             protection of databases, and under any national implementation
             thereof, including any amended or successor version of such
             directive); and
        vii. other similar, equivalent or corresponding rights throughout the
             world based on applicable law or treaty, and any national
             implementations thereof.
        
        2. Waiver. To the greatest extent permitted by, but not in contravention
        of, applicable law, Affirmer hereby overtly, fully, permanently,
        irrevocably and unconditionally waives, abandons, and surrenders all of
        Affirmer's Copyright and Related Rights and associated claims and causes
        of action, whether now known or unknown (including existing as well as
        future claims and causes of action), in the Work (i) in all territories
        worldwide, (ii) for the maximum duration provided by applicable law or
        treaty (including future time extensions), (iii) in any current or future
        medium and for any number of copies, and (iv) for any purpose whatsoever,
        including without limitation commercial, advertising or promotional
        purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
        member of the public at large and to the detriment of Affirmer's heirs and
        successors, fully intending that such Waiver shall not be subject to
        revocation, rescission, cancellation, termination, or any other legal or
        equitable action to disrupt the quiet enjoyment of the Work by the public
        as contemplated by Affirmer's express Statement of Purpose.
        
        3. Public License Fallback. Should any part of the Waiver for any reason
        be judged legally invalid or ineffective under applicable law, then the
        Waiver shall be preserved to the maximum extent permitted taking into
        account Affirmer's express Statement of Purpose. In addition, to the
        extent the Waiver is so judged Affirmer hereby grants to each affected
        person a royalty-free, non transferable, non sublicensable, non exclusive,
        irrevocable and unconditional license to exercise Affirmer's Copyright and
        Related Rights in the Work (i) in all territories worldwide, (ii) for the
        maximum duration provided by applicable law or treaty (including future
        time extensions), (iii) in any current or future medium and for any number
        of copies, and (iv) for any purpose whatsoever, including without
        limitation commercial, advertising or promotional purposes (the
        "License"). The License shall be deemed effective as of the date CC0 was
        applied by Affirmer to the Work. Should any part of the License for any
        reason be judged legally invalid or ineffective under applicable law, such
        partial invalidity or ineffectiveness shall not invalidate the remainder
        of the License, and in such case Affirmer hereby affirms that he or she
        will not (i) exercise any of his or her remaining Copyright and Related
        Rights in the Work or (ii) assert any associated claims and causes of
        action with respect to the Work, in either case contrary to Affirmer's
        express Statement of Purpose.
        
        4. Limitations and Disclaimers.
        
         a. No trademark or patent rights held by Affirmer are waived, abandoned,
            surrendered, licensed or otherwise affected by this document.
         b. Affirmer offers the Work as-is and makes no representations or
            warranties of any kind concerning the Work, express, implied,
            statutory or otherwise, including without limitation warranties of
            title, merchantability, fitness for a particular purpose, non
            infringement, or the absence of latent or other defects, accuracy, or
            the present or absence of errors, whether or not discoverable, all to
            the greatest extent permissible under applicable law.
         c. Affirmer disclaims responsibility for clearing rights of other persons
            that may apply to the Work or any use thereof, including without
            limitation any person's Copyright and Related Rights in the Work.
            Further, Affirmer disclaims responsibility for obtaining any necessary
            consents, permissions or other rights required for any use of the
            Work.
         d. Affirmer understands and acknowledges that Creative Commons is not a
            party to this document and has no duty or obligation with respect to
            this CC0 or use of the Work.
        
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: boto3
Requires-Dist: mutagen
Requires-Dist: certifi
Requires-Dist: charset-normalizer
Requires-Dist: idna
Requires-Dist: redis<=4.6.0
Requires-Dist: requests
Requires-Dist: markdown
Requires-Dist: PyYAML

# CoAiAPy

CoAiAPy is a Python package that provides a CLI tool for audio transcription, text summarization, and Redis stashing. It leverages OpenAI for text processing and Redis for data storage.

## Features

- **Audio Transcription**: Converts audio files to text using the OpenAI Whisper API.
- **Text Summarization**: Summarizes text using the OpenAI API.
- **Redis Stashing**: Stores key-value pairs in a Redis database.
- **Custom Process Tags**: Enables custom text processing using configurations defined in `coaia.json`.
- **Langfuse Integration**: Supports tracing and monitoring using Langfuse.

## Installation

To install the package, use pip:

```bash
pip install coaiapy
```

## Configuration

Before using CoAiAPy, you need to set up a configuration file (`coaia.json`) in your home directory or the current working directory. You can create a sample configuration file by running:

```bash
coaia init
```

This will create a `coaia.json` file in your home directory (`~/.config/jgwill/coaia.json` or `~/coaia.json`) with placeholder values. You need to replace these placeholders with your actual API keys and Redis credentials.

### Environment Variables

The following environment variables can be used to override the values in the `coaia.json` file:

- `OPENAI_API_KEY`: OpenAI API key.
- `AWS_KEY_ID`: AWS key ID for Polly service.
- `AWS_SECRET_KEY`: AWS secret key for Polly service.
- `AWS_REGION`: AWS region for Polly service.
- `REDIS_HOST`: Redis host.
- `REDIS_PORT`: Redis port.
- `REDIS_PASSWORD`: Redis password.
- `REDIS_SSL`: Redis SSL setting.
- `UPSTASH_HOST`: Upstash host (alternative to Redis).
- `UPSTASH_PASSWORD`: Upstash password (alternative to Redis).

## Usage

### CLI Tool

CoAiAPy provides a command-line interface (`coaia`) for various tasks.

#### Help

To display help information, use the `--help` flag:

```bash
coaia --help
```

#### Transcribe Audio

To transcribe an audio file to text:

```bash
coaia transcribe <file_path> [-O <output_file>]
```

- `<file_path>`: Path to the audio file.
- `-O <output_file>`: Optional output file to save the transcribed text. If not specified, the text will be printed to the console.

Example:

```bash
coaia transcribe audio.mp3 -O output.txt
```

#### Summarize Text

To summarize text from a file or standard input:

```bash
coaia summarize [<file_path>] [-O <output_file>]
```

- `<file_path>`: Optional path to a file containing the text to summarize. If not specified, the text will be read from standard input.
- `-O <output_file>`: Optional output file to save the summarized text. If not specified, the text will be printed to the console.

Examples:

```bash
coaia summarize text.txt -O summary.txt
cat text.txt | coaia summarize -O summary.txt
coaia summarize -O summary.txt < text.txt
```

#### Stash Key-Value Pair to Redis

To stash a key-value pair to Redis:

```bash
coaia tash <key> <value> [-T <ttl>]
coaia tash <key> -F <file_path> [-T <ttl>]
```

- `<key>`: The key to stash.
- `<value>`: The value to stash.
- `-F <file_path>`: Read the value from a file.
- `-T <ttl>`: Time-to-live in seconds for the key. Defaults to 5555.

Examples:

```bash
coaia tash my_key "This is the value" -T 3600
coaia tash my_key -F value.txt -T 3600
```

#### Process with Custom Tag

To process input with a custom tag defined in `coaia.json`:

```bash
coaia p <process_name> <input_message> [-O <output_file>] [-F <file_path>]
```

- `<process_name>`: The name of the process tag defined in `coaia.json`.
- `<input_message>`: The input message to process.
- `-O <output_file>`: Optional output file to save the processed text. If not specified, the text will be printed to the console.
- `-F <file_path>`: Read the input message from a file.

Example:

```bash
coaia p dictkore "correct my dictation" -O corrected.txt
coaia p dictkore -F input.txt -O corrected.txt
```

Ensure that the `coaia.json` file contains the necessary configurations for the process tag, including `process_name_instruction` and `process_name_temperature`.

#### Langfuse Integration

CoAiAPy supports integration with Langfuse for tracing and monitoring. The `fuse` command provides subcommands for managing comments, prompts, datasets, sessions, scores, and traces.

##### Comments

```bash
coaia fuse comments <list|post> [<comment_text>]
```

- `list`: List comments.
- `post`: Post a comment.
- `<comment_text>`: The comment text to post.

##### Prompts

```bash
coaia fuse prompts <list|get|create> [<name>] [<content>]
```

- `list`: List prompts.
- `get`: Get a prompt by name.
- `create`: Create a prompt.
- `<name>`: The prompt name.
- `<content>`: The prompt content.

##### Datasets

```bash
coaia fuse datasets <list|get|create> [<name>]
```

- `list`: List datasets.
- `get`: Get a dataset by name.
- `create`: Create a dataset.
- `<name>`: The dataset name.

##### Sessions

```bash
coaia fuse sessions <create|addnode|view> ...
```

- `create`: Create a session.
  ```bash
  coaia fuse sessions create <session_id> <user_id> [-n <name>] [-f <file>]
  ```
- `addnode`: Add a node to a session.
  ```bash
  coaia fuse sessions addnode <session_id> <trace_id> <user_id> [-n <name>] [-f <file>]
  ```
- `view`: View a session.
  ```bash
  coaia fuse sessions view [-f <file>]
  ```
  - `-f <file>`: YAML file to store session data (default: `session.yml`).

##### Scores

```bash
coaia fuse scores <create|apply> ...
```

- `create`: Create a score.
  ```bash
  coaia fuse scores create <score_id> [-n <name>] [-v <value>]
  ```
- `apply`: Apply a score to a trace.
  ```bash
  coaia fuse scores apply <trace_id> <score_id> [-v <value>]
  ```

##### Traces

```bash
coaia fuse traces <list|add> ...
```

- `list`: List traces.
- `add`: Add a trace.
  ```bash
  coaia fuse traces add <trace_id> -s <session_id> -u <user_id> -n <name> [-d <data>]
  ```
  - `-d <data>`: Additional trace data as JSON string.

##### Projects

```bash
coaia fuse projects
```

- List projects.

##### Dataset Items

```bash
coaia fuse dataset-items create <datasetName> -i <input> [-e <expected>] [-m <metadata>]
```

- `create`: Create a dataset item.
  - `-i <input>`: Input data.
  - `-e <expected>`: Expected output.
  - `-m <metadata>`: Optional metadata as JSON string.

#### Init

To create a default coaia.json file

```bash
coaia init
```

## Contributing

Contributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.

## License

This project is licensed under the MIT License. See the LICENSE file for more details.

