Stevenic / agentm-py

A library of "Micro Agents" that make it easy to add reliable intelligence to any application.
MIT License
8 stars 3 forks source link

Documentation and Examples Update for AgentM Python Migration #28

Open debuggerone opened 2 months ago

debuggerone commented 2 months ago

Overview

This issue focuses on updating the documentation and examples for the Python version of the AgentM library. The goal is to ensure that all documentation reflects the new Python implementation and provides clear, accurate information for users and contributors.

Tasks

Subtasks Overview

  1. Update Documentation:

    • Revise all existing documentation to align with the Python implementation.
    • Ensure all code includes comprehensive docstrings, and establish a clear structure for documentation files.
  2. Convert Example Scripts:

    • Translate JavaScript example scripts into Python, preserving all functionality and ensuring they work correctly in the Python environment.
  3. Readme and Setup Instructions:

    • Update the README file to reflect the Python setup process, usage, and contribution guidelines.
  4. Contribute.md:

    • Develop a Contribute.md file that provides clear instructions for contributing to the Python version of AgentM.
debuggerone commented 2 months ago

Added an INSTALL.md - for now without the pypi package

Stevenic commented 2 months ago

I would focus on porting the core components first and then pick an example or two... maintaining examples can easily be a fulltime job on its own

debuggerone commented 2 months ago

Exactly my plan.

When you look into the INSTALL.md - I've put a structure there.. although I guess the core folder could be moved to src .. or could be an own package..

Will sleep another night over it.

debuggerone commented 2 months ago

have added the core functionality - although it is not fully dynamic yet.. (some hardcoded stuff in it atm - which I am going to remove when I add the examples)