Files
2026-09-29 10:04:57 +02:00

2.0 KiB

Fiona Assistant

A collection of tools for managing the LLM wiki and related operations.

Overview

The Fiona Assistant project provides command-line tools for:

  • Librarian: Managing LLM wiki content and operations
  • MDoctor: [Description to be added]

Installation

Development Setup

  1. Clone the repository:

    git clone <repository-url>
    cd fiona-assistant
    
  2. Set up the Python environment using the bootstrap script.

    Linux / macOS:

    source bootstrap --env fiona_env
    

    Or with a specific Python version:

    source bootstrap --env fiona_env --python 3.11.0
    

    Windows (PowerShell):

    Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
    . .\bootstrap.ps1 --env fiona_env --python 3.11.0
    
  3. Install the package in development mode:

    pip install -e .
    

Install with Development Dependencies

pip install -e ".[dev]"

Usage

Librarian

See librarian/README.md for detailed usage.

librarian --help

MDoctor

See mdoctor/README.md for detailed usage.

mdoctor --help

Project Structure

src/
├── fiona/          # Main package
├── librarian/      # Wiki content management tool
├── mdoctor/        # [Tool description]
├── tests/          # Unit tests
└── README.md       # This file

Running Tests

# Run all tests
pytest

# Run with coverage
pytest --cov=src

Development Tools

The project includes several development utilities:

  • bootstrap: Set up the Python development environment (bash)
  • bootstrap.ps1: Set up the Python development environment (PowerShell)
  • src/utils.sh: Shell utility functions
  • src/install_packages.sh: Install local Python packages
  • src/run_tests.sh: Run the test suite

License

GPL-3.0-only

Contributing

[Contribution guidelines to be added]