stage0-py-utils 0.2.6

A utility package for stage0 microservices

stage0_py_utils

This repo publishes the a pypl module that contains utility code used throughout the stage0 system. See the server.py for an example of how to use this code. See the ECHO documentation for information on how the Stage0 Echo Bot is implemented.

Contributing

Prerequisites

• Stage0 Developer Edition #TODO for now just Docker
• Python 3.12
• Pipenv

Optional

• Mongo Compass - if you want a way to look into the database

Folder structure for source code

📁 stage0_py_utils/                 # Repo root
│── 📁 stage0_py_utils/
│   │── 📁 agents/                 # Echo Agents (Bot, Conversation, Echo)
│   │── 📁 config/                 # System Wide configuration
│   │── 📁 echo/                   # Echo Chat AI Framework
│   │── 📁 echo_utils/             # Echo related utilities
│   │── 📁 flask_utils/            # Flask related utilities
│   │── 📁 mongo_utils/            # MongoDB Utilities
│   │── 📁 evaluator/              # Echo evaluation utility
│   │── 📁 routes/                 # Echo Flask Routes
│   │── 📁 services/               # Echo Persistence Services (Bot, Conversation)
│   
│── 📁 tests/                      # unittest code structure matches source
│   │── 📁 agents/                       
│   │── 📁 config/                 
│   │── 📁 echo/                   
│   │── ....
│   │── 📁 test_data/              # Testing Data
│   │   │── 📁 config/               # Config file testing data
│   │   │── 📁 evaluate/             # Echo Evaluate test data
│   
│── README.md
│── ...

---

Pipenv Commands

We use pipenv automation to manage dependencies and automate common tasks. Note that running the sample server will use the configuration values (Tokens, ID's, Port, etc.) from the FRAN bot. You can not run the sample server if the FRAN bot is already running.

Install Dependencies

pipenv install

Clean any previous build output

pipenv run clean

Build the Package

pipenv run build

Check the Package is ready for publication

pipenv run check

Publish the Package

pipenv run publish

NOTE: You should not need to use this, publishing is handled by GitHub Actions CI

Run sample server locally

pipenv run local

Run sample server locally with DEBUG logging

pipenv run debug

Run stepCI testing of Flask API endpoints

pipenv run stepci

NOTE: This assumes that the server is running at localhost:8580. Use pipenv run local to start the server if needed