genai4sa 0.2.1

A software architecture generation tool using LLMs

GenAI-for-SA

A tool to generate software design document using LLM models and different prompting techniques.

How to use the tool:

    1. Enter the API Key for OpenAI, GoogleAI or GroqAI depending on the model you want to use.
    2. Select the Model to use.
    3. Select the Prompting technique to use.
    4. Input the textual description of the system. 
    5. Press Generate and wait for the PDF to open. The PDF will be saved in the current working directory 
    from where you ran the tool.
    6. If you want to continue the conversation and iterate over the LLM respond, set Continue Conversation 
    to Yes, and enter the prompt in Textbox and Press Generate.

How to download the library and run the tool:

    1. Install with this command (enter in command prompt/terminal):
        pip install genai4sa
    2. Run with this command:
        genai4sa

How to Contribute:

    1. Fork the repository at https://github.com/yorku-ease/devbot_SA
    2. Create a feature branch: `git checkout -b feature/my-feature`
    3. Make your changes and test.
    4. Commit and push.
    5. Open a Pull Request (PR)

How to run locally

    1. Open terminal and go to where repo was cloned.
            cd <repo name>
    2. Run this command there to create a virtual environment (Only when running the First Time, Skip to 3rd step otherwise)
            python -m venv venv
    3. Then run this command to activate the virtual environment
            For macOS/Linux:
                    source venv/bin/activate
            For Windows (PowerShell)
                    .\venv\Scripts\Activate.ps1
            (If you get the error saying running scripts is disabled on this system… -> Run this command in the root folder in PowerShell)
                    Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy RemoteSigned
            (When prompted, type Y and press Enter.) 
    4. Run this command there
            pip install -e .
    5. Then enter this command to run the program
            genai4sa