uis-sprint-report 0.1.0__tar.gz

uis-sprint-report-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 E. Evstafiev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

uis-sprint-report-0.1.0/PKG-INFO

@@ -0,0 +1,80 @@
+Metadata-Version: 2.1
+Name: uis-sprint-report
+Version: 0.1.0
+Summary: A Python package for generating sprint reports and managing sprint activities at University Information Services.
+Home-page: https://gitlab.developers.cam.ac.uk/ee345/demo
+Author: Eugene Evstafev
+Author-email: ee345@cam.ac.uk
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# Project Overview
+
+This project leverages the capabilities of the LangChain library to interact with GitLab issues and generate sprint report presentations. The system retrieves issue data from a specified GitLab group, processes the information, and summarizes the status of sprint goals in a PowerPoint presentation.
+
+## Features
+
+- Retrieve issues from GitLab using a specific label and iteration ID.
+- Analyze and categorize issues based on sprint goals.
+- Generate summaries and status reports for sprint goals.
+- Create PowerPoint presentations to visually present the sprint report.
+
+## Prerequisites
+
+Before you can run this project, you need to have Python installed on your machine. Python 3.6 or higher is recommended. You also need to ensure that Git is installed if you need to clone the repository.
+
+## Installation
+
+1. **Clone the Repository**:
+   ```bash
+   git clone https://gitlab.developers.cam.ac.uk/ee345/demo.git
+   cd demo
+   ```
+
+2. **Install Required Libraries**:
+   Ensure you have `pip` installed and then run:
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+3. **Download and Setup Ollama Model**:
+   Download the Ollama model from [Ollama Download](https://ollama.com/download) and [Mistral Model](https://ollama.com/library/mistral). Follow the instructions on the Ollama website for setting up the model.
+
+## Usage
+
+To run the script, use the following command. Replace the placeholder values with actual data like the GitLab access token and other parameters as required:
+
+```bash
+python main.py --token YOUR_GITLAB_ACCESS_TOKEN --gitlab_url https://gitlab.developers.cam.ac.uk/api/v4 --iteration_id=368 --goals "Front End Error Reporting,Gain access to account data (held in Entra ID and in our own systems) to start to understand user breakdown/profiles between Raven/Azure"
+```
+
+### Parameters Description
+
+- `--token`: GitLab access token for authentication. This is necessary to access the GitLab API securely.
+- `--gitlab_url`: The base URL of your GitLab instance API. Default is `https://gitlab.developers.cam.ac.uk/api/v4`.
+- `--group_id`: The ID of the GitLab group from which issues are to be fetched. Default is `5`.
+- `--labels`: URL-encoded string of labels used to filter issues by specific criteria. Default is `team%3A%3AIdentity`.
+- `--iteration_id`: The ID of the specific iteration to filter issues relevant to a particular sprint. Leave empty if not using iteration-based filtering.
+- `--goals`: A comma-separated list of sprint goals to analyze. Each goal should be clearly defined.
+- `--presentation_name`: The name of the output PowerPoint file where the sprint report will be saved. Default is `demo.pptx`.
+- `--chunk_size`: The size of text chunks in characters when splitting documents for processing. Default is `500`.
+- `--chunk_overlap`: The overlap of text chunks in characters when splitting documents. Default is `0`.
+- `--search_type`: The type of search to perform when retrieving documents. Default is `mmr` which stands for Maximal Marginal Relevance.
+- `--search_kwargs`: Additional keyword arguments in JSON format to configure the search behavior. Default is `{"k": 8}`, where `k` is the number of documents to retrieve.
+- `--cache_folder`: The directory to use for caching data such as embeddings. Default is `cache`.
+- `--model`: The language model to use, specified by name. Default is `mistral`.
+- `--max_tokens`: The maximum number of tokens to generate from the language model in a single request. Default is `1500`.
+
+## Contributing
+
+Contributions are welcome! For major changes, please open an issue first to discuss what you would like to change.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE) file for details.

uis-sprint-report-0.1.0/README.md

@@ -0,0 +1,64 @@
+# Project Overview
+
+This project leverages the capabilities of the LangChain library to interact with GitLab issues and generate sprint report presentations. The system retrieves issue data from a specified GitLab group, processes the information, and summarizes the status of sprint goals in a PowerPoint presentation.
+
+## Features
+
+- Retrieve issues from GitLab using a specific label and iteration ID.
+- Analyze and categorize issues based on sprint goals.
+- Generate summaries and status reports for sprint goals.
+- Create PowerPoint presentations to visually present the sprint report.
+
+## Prerequisites
+
+Before you can run this project, you need to have Python installed on your machine. Python 3.6 or higher is recommended. You also need to ensure that Git is installed if you need to clone the repository.
+
+## Installation
+
+1. **Clone the Repository**:
+   ```bash
+   git clone https://gitlab.developers.cam.ac.uk/ee345/demo.git
+   cd demo
+   ```
+
+2. **Install Required Libraries**:
+   Ensure you have `pip` installed and then run:
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+3. **Download and Setup Ollama Model**:
+   Download the Ollama model from [Ollama Download](https://ollama.com/download) and [Mistral Model](https://ollama.com/library/mistral). Follow the instructions on the Ollama website for setting up the model.
+
+## Usage
+
+To run the script, use the following command. Replace the placeholder values with actual data like the GitLab access token and other parameters as required:
+
+```bash
+python main.py --token YOUR_GITLAB_ACCESS_TOKEN --gitlab_url https://gitlab.developers.cam.ac.uk/api/v4 --iteration_id=368 --goals "Front End Error Reporting,Gain access to account data (held in Entra ID and in our own systems) to start to understand user breakdown/profiles between Raven/Azure"
+```
+
+### Parameters Description
+
+- `--token`: GitLab access token for authentication. This is necessary to access the GitLab API securely.
+- `--gitlab_url`: The base URL of your GitLab instance API. Default is `https://gitlab.developers.cam.ac.uk/api/v4`.
+- `--group_id`: The ID of the GitLab group from which issues are to be fetched. Default is `5`.
+- `--labels`: URL-encoded string of labels used to filter issues by specific criteria. Default is `team%3A%3AIdentity`.
+- `--iteration_id`: The ID of the specific iteration to filter issues relevant to a particular sprint. Leave empty if not using iteration-based filtering.
+- `--goals`: A comma-separated list of sprint goals to analyze. Each goal should be clearly defined.
+- `--presentation_name`: The name of the output PowerPoint file where the sprint report will be saved. Default is `demo.pptx`.
+- `--chunk_size`: The size of text chunks in characters when splitting documents for processing. Default is `500`.
+- `--chunk_overlap`: The overlap of text chunks in characters when splitting documents. Default is `0`.
+- `--search_type`: The type of search to perform when retrieving documents. Default is `mmr` which stands for Maximal Marginal Relevance.
+- `--search_kwargs`: Additional keyword arguments in JSON format to configure the search behavior. Default is `{"k": 8}`, where `k` is the number of documents to retrieve.
+- `--cache_folder`: The directory to use for caching data such as embeddings. Default is `cache`.
+- `--model`: The language model to use, specified by name. Default is `mistral`.
+- `--max_tokens`: The maximum number of tokens to generate from the language model in a single request. Default is `1500`.
+
+## Contributing
+
+Contributions are welcome! For major changes, please open an issue first to discuss what you would like to change.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE) file for details.

uis-sprint-report-0.1.0/demo/__init__.py

@@ -0,0 +1 @@
+from .main import demo

uis-sprint-report-0.1.0/demo/config.py

@@ -0,0 +1,12 @@
+CACHE_FILE              = ".cache"
+CHUNK_SIZE              = 500
+CHUNK_OVERLAP           = 0
+DEFAULT_API_BASE        = "https://gitlab.developers.cam.ac.uk/"
+DEFAULT_MODEL           = "mistral:latest"
+DEFAULT_COMMAND         = "report"
+DEFAULT_LABELS          = "team::Identity"
+DEFAULT_GROUP_ID        = 5
+DEFAULT_ITERATION_ID    = 383
+DEFAULT_PPTX_FILE_NAME  = "../sprint_goals.pptx"
+MAX_TOKENS              = 1500
+MAX_ATTEMPTS            = 5

uis-sprint-report-0.1.0/demo/demo.py

@@ -0,0 +1,118 @@
+from rich import print
+from rich.table import Table
+from pptx import Presentation
+
+from langchain_core.output_parsers import PydanticOutputParser
+from langchain_core.prompts import ChatPromptTemplate
+from langchain_core.runnables import RunnablePassthrough
+from langchain_community.chat_models import ChatOllama
+from .prompts import prompts
+from .models import SprintReport, ResponseModel
+
+
+def prepare_parser_and_prompt(model):
+    """Prepare parser and prompt template for structured outputs."""
+    parser = PydanticOutputParser(pydantic_object=model)
+    prompt_template = ChatPromptTemplate.from_messages([
+        ("system",
+         "Answer the user query. Wrap the output in `json` tags\n{format_instructions}. The context is {context}"),
+        ("human", "{query}"),
+    ]).partial(format_instructions=parser.get_format_instructions())
+
+    return parser, prompt_template
+
+
+def prepare_chain(llm, retriever, model):
+    parser, prompt_template = prepare_parser_and_prompt(model)
+    return {"context": retriever, "query": RunnablePassthrough()} | prompt_template | llm | parser
+
+
+def invoke_chain(chain, prompt, max_attempts):
+    count_attempts = 0
+    while count_attempts < max_attempts:
+        try:
+            response = chain.invoke(prompt)
+            return response
+        except Exception as e:
+            count_attempts += 1
+    print("[red]❌ Unable to generate answer[/red]")
+
+
+def get_report(llm, embeddings, max_attempts, sprint_goals=None):
+    chain = prepare_chain(llm, embeddings, SprintReport)
+    prompt = prompts['generate_report']['question']
+    if sprint_goals is not None:
+        prompt += prompts['generate_report']['additional_info'] + sprint_goals
+    report = invoke_chain(chain, prompt, max_attempts)
+    return report
+
+
+def report(llm, embeddings, max_attempts):
+    print("[bold]Generating report...[/bold]")
+    report = get_report(llm, embeddings, max_attempts)
+
+    table = Table(title="Sprint Activities Report")
+
+    table.add_column("Title", style="cyan", no_wrap=True)
+    table.add_column("Description", style="magenta")
+    table.add_column("Status", style="green")
+
+    for activity in report.activities:
+        table.add_row(
+            activity.title,
+            activity.brief_desc_status,
+            activity.status
+        )
+
+    print("[green]✅ Report generated[/green]")
+    print(table)
+
+
+def pptx(llm, embeddings, max_attempts, sprint_goals, pptx_file_name):
+    report = get_report(llm, embeddings, max_attempts, sprint_goals)
+
+    prs = Presentation()
+    slide_layout = prs.slide_layouts[1]
+
+    slide = prs.slides.add_slide(slide_layout)
+    title = slide.shapes.title
+    content = slide.placeholders[1]
+
+    title.text = "Sprint Activities Report"
+    content.text = "Activities Summary:\n"
+
+    for activity in report.activities:
+        content.text += f"- {activity.title}: {activity.brief_desc_status} (Status: {activity.status})\n"
+
+    prs.save(pptx_file_name)
+    print("[green]✅ PowerPoint report generated[/green]")
+
+
+def chat(llm, embeddings, max_attempts):
+    is_end = False
+    while not is_end:
+        user_input = input("You: ")
+        if user_input == "exit" or user_input == "quit" or user_input == "q":
+            is_end = True
+            print("[bold]👋 Goodbye![/bold]")
+            break
+        chain = prepare_chain(llm, embeddings, ResponseModel)
+        response = invoke_chain(
+            chain,
+            user_input + "\n" + prompts['chat']['question'],
+            max_attempts
+        )
+        print(f"Bot: {response}")
+
+
+def execute_command(command, embeddings, model, max_tokens, max_attempts, sprint_goals, pptx_file_name):
+    llm = ChatOllama(model=model, max_tokens=max_tokens)
+    if command == "report":
+        report(llm, embeddings, max_attempts)
+    elif command == "pptx":
+        pptx(llm, embeddings, max_attempts, sprint_goals, pptx_file_name)
+    elif command == "chat":
+        chat(llm, embeddings, max_attempts)
+    else:
+        print("Invalid command")
+        raise Exception("Invalid command")

uis-sprint-report-0.1.0/demo/embeddings.py

@@ -0,0 +1,43 @@
+from rich import print
+from .utils import manage_cache_file
+from get_gitlab_issues import get_gitlab_issues, get_gitlab_issue
+
+from langchain_community.document_loaders import TextLoader
+from langchain_text_splitters import CharacterTextSplitter
+from langchain_community.vectorstores import FAISS
+
+
+def generate_embeddings(
+        api_base,
+        access_token,
+        labels,
+        group_id,
+        iteration_id,
+        cache_file,
+        chunk_size,
+        chunk_overlap,
+        embedding_model,
+        sprint_goals
+):
+    print("[green]Recieveing issues from GitLab...[/green]")
+    issues = get_gitlab_issues(access_token, api_base, group_id, labels, iteration_id)
+    board = []
+    for issue in issues:
+        issue = issue.attributes
+        board.append(issue)
+
+    print("[green]✅ Issues received[/green]")
+    manage_cache_file(create=True, content=sprint_goals+"\n "+str(board))
+
+    print("[green]Generate embeddings...[/green]")
+    loader = TextLoader(cache_file)
+    documents = loader.load()
+    splitter = CharacterTextSplitter(chunk_size=chunk_size, chunk_overlap=chunk_overlap)
+    texts = splitter.split_documents(documents)
+
+    embedding = embedding_model
+    vector_store = FAISS.from_documents(texts, embedding)
+    retriever = vector_store.as_retriever()
+    manage_cache_file(content="")
+    print("[green]✅ Embeddings generated[/green]")
+    return retriever

uis-sprint-report-0.1.0/demo/main.py

@@ -0,0 +1,73 @@
+import click
+from .utils import check_gitlab_credentials, check_ollama
+from .embeddings import generate_embeddings
+from langchain_huggingface import HuggingFaceEmbeddings
+
+from .demo import execute_command
+from .config import (
+    DEFAULT_API_BASE,
+    DEFAULT_COMMAND,
+    DEFAULT_GROUP_ID,
+    DEFAULT_ITERATION_ID,
+    DEFAULT_LABELS,
+    DEFAULT_MODEL,
+    DEFAULT_PPTX_FILE_NAME,
+    CACHE_FILE,
+    CHUNK_SIZE,
+    CHUNK_OVERLAP,
+    MAX_TOKENS,
+    MAX_ATTEMPTS
+)
+
+
+@click.command()
+@click.option("--api-base",     default=DEFAULT_API_BASE,       metavar="BASE_URL")
+@click.option("--access-token", default=None,                   metavar="ACCESS_TOKEN")
+@click.option("--command",      default=DEFAULT_COMMAND,        metavar="COMMAND")
+@click.option("--group-id",     default=DEFAULT_GROUP_ID,       metavar="GROUP_ID")
+@click.option("--iteration-id", default=DEFAULT_ITERATION_ID,   metavar="ITERATION_ID")
+@click.option("--labels",       default=DEFAULT_LABELS,         metavar="LABELS")
+@click.option("--model",        default=DEFAULT_MODEL,          metavar="MODEL")
+@click.option("--cache-file",   default=CACHE_FILE,             metavar="CACHE_FILE")
+@click.option("--chunk-size",   default=CHUNK_SIZE,             metavar="CHUNK_SIZE")
+@click.option("--chunk-overlap",default=CHUNK_OVERLAP,          metavar="CHUNK_OVERLAP")
+@click.option("--max-tokens",   default=MAX_TOKENS,             metavar="MAX_TOKENS")
+@click.option("--sprint-goals", default="",                     metavar="SPRINT_GOALS")
+@click.option("--pptx-file",    default=DEFAULT_PPTX_FILE_NAME, metavar="PPTX_FILE")
+@click.option("--max-attempts", default=MAX_ATTEMPTS,           metavar="MAX_ATTEMPTS")
+def demo(
+        api_base: str,
+        access_token: str,
+        model: str,
+        command: str,
+        labels: str,
+        iteration_id: int,
+        group_id: int,
+        cache_file: str,
+        chunk_size: int,
+        chunk_overlap: int,
+        max_tokens: int,
+        sprint_goals: str,
+        pptx_file: str,
+        max_attempts: int
+):
+    check_gitlab_credentials(access_token, api_base)
+    check_ollama(model)
+    embedding_model = HuggingFaceEmbeddings()
+    embeddings = generate_embeddings(
+        api_base,
+        access_token,
+        labels,
+        group_id,
+        iteration_id,
+        cache_file,
+        chunk_size,
+        chunk_overlap,
+        embedding_model,
+        sprint_goals
+    )
+    execute_command(command, embeddings, model, max_tokens, max_attempts, sprint_goals, pptx_file)
+
+
+if __name__ == "__main__":
+    demo()

uis-sprint-report-0.1.0/demo/models.py

@@ -0,0 +1,16 @@
+from langchain_core.pydantic_v1 import BaseModel, Field
+from typing import List
+
+
+class Activity(BaseModel):
+    title: str = Field(..., description="The title of the activity, summarizing the main goal or purpose of the activity.")
+    brief_desc_status: str = Field(..., description="A short and concise description of the status activity, summarizing its main status.")
+    status: str = Field(..., description="The current status of the activity, indicating its progress such as 'Planned', 'InProgress', or 'Completed'.")
+
+
+class SprintReport(BaseModel):
+    activities: List[Activity] = Field(..., description="A list of main activities, each described with a title, brief description status, and current status, summarizing the sprint's progress.")
+
+
+class ResponseModel(BaseModel):
+    response: str = Field(..., description="The response to the user query, providing the requested information.")

uis-sprint-report-0.1.0/demo/prompts.py

@@ -0,0 +1,9 @@
+prompts = {
+    "generate_report": {
+        "question": "Generate a JSON-formatted concise report summarizing the main activities from the sprint board. For each activity, include a title, a brief status description and its current status. The JSON should be structured as a list of activities, each with `title`, 'brief_desc_status' and 'status' fields. Status examples include 'Planned', 'InProgress', 'Completed', 'Blocked', and 'Closed'. This structured report should provide a clear overview of the sprint's progress and highlight areas needing attention. Example of expected JSON output: {'activities':[{'title':'Update project documentation','brief_desc_status':'The most of the issues are resolved','status':'InProgress'},{'title':'Fix the critical bug','brief_desc_status':'The bug is fixed, but the tests are failing','status':'Blocked'}]}",
+        "additional_info": "The sprint goals were:",
+    },
+    "chat": {
+        "question": "The answer should be a JSON-formatted response to the user query. The example is {'response':'The answer to the user query'}",
+    }
+}

uis-sprint-report-0.1.0/demo/utils.py

@@ -0,0 +1,33 @@
+import os
+import ollama
+from rich import print
+from get_gitlab_issues import check_access
+from .config import CACHE_FILE
+
+
+def check_gitlab_credentials(token, url):
+    if not check_access(token, url):
+        print(f"[red]Invalid GitLab credentials[/red]")
+        raise Exception("Invalid GitLab credentials")
+    print("[green]GitLab credentials are valid[/green]")
+
+
+def check_ollama(model=None):
+    try:
+        models = ollama.list()['models']
+        if models and not any(m['name'] == model for m in models):
+            print(f"[red]Invalid Ollama model[/red]")
+            raise Exception("Invalid Ollama model")
+    except Exception as e:
+        print(f"[red]Ollama is not running. Error: {e}[/red]")
+        raise Exception("Ollama is not running")
+    print("[green]Ollama model is valid[/green]")
+
+
+def manage_cache_file(create=False, content=None):
+    if create:
+        with open(CACHE_FILE, 'w') as f:
+            f.write(content)
+    else:
+        if os.path.exists(CACHE_FILE):
+            os.remove(CACHE_FILE)

uis-sprint-report-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

uis-sprint-report-0.1.0/setup.py

@@ -0,0 +1,38 @@
+from setuptools import setup, find_packages
+
+
+setup(
+    name='uis-sprint-report',
+    version='0.1.0',
+    author='Eugene Evstafev',
+    author_email='ee345@cam.ac.uk',
+    description='A Python package for generating sprint reports and managing sprint activities at University Information Services.',
+    long_description=open('README.md').read(),
+    long_description_content_type='text/markdown',
+    url='https://gitlab.developers.cam.ac.uk/ee345/demo',
+    packages=find_packages(),
+    install_requires=[
+        'click>=8.1.7',
+        'rich>=13.7.1',
+        'python-pptx>=0.6.23',
+        'huggingface-hub==0.23.4',
+        'langchain==0.2.6',
+        'langchain-community==0.2.6',
+        'langchain-core==0.2.10',
+        'langchain-huggingface==0.0.3',
+        'langchain-text-splitters==0.2.2',
+        'faiss-cpu>=1.8.0',
+        'pydantic>=2.7.4',
+        'scikit-learn>=0.24.1',
+        'torch>=1.9.0',
+        'transformers>=4.42.3'
+    ],
+    classifiers=[
+        'License :: OSI Approved :: MIT License',
+        'Development Status :: 4 - Beta',
+        'Intended Audience :: Developers',
+        'Programming Language :: Python :: 3',
+        'Operating System :: OS Independent',
+    ],
+    python_requires='>=3.7',
+)

uis-sprint-report-0.1.0/tests/test_demo.py

@@ -0,0 +1,49 @@
+import pytest
+from unittest.mock import patch, MagicMock
+from click.testing import CliRunner
+from demo.main import demo
+
+
+@pytest.fixture
+def runner():
+    return CliRunner()
+
+
+def test_valid_command_execution(runner):
+    with patch("demo.main.check_gitlab_credentials") as mock_check_gitlab_credentials, \
+         patch("demo.main.check_ollama") as mock_check_ollama, \
+         patch("demo.main.generate_embeddings") as mock_generate_embeddings, \
+         patch("demo.main.execute_command") as mock_execute_command, \
+         patch("demo.main.HuggingFaceEmbeddings") as mock_hugging_face_embeddings:
+
+        mock_hugging_face_embeddings.return_value = MagicMock()
+        mock_generate_embeddings.return_value = "mock_embeddings"
+
+        result = runner.invoke(demo, [
+            "--api-base", "http://api.gitlab.com",
+            "--access-token", "valid_token",
+            "--command", "report",
+            "--model", "test_model",
+            "--group-id", "123",
+            "--iteration-id", "456",
+            "--labels", "bug",
+            "--sprint-goals", "Complete all tasks"
+        ])
+
+        assert result.exit_code == 0
+        mock_check_gitlab_credentials.assert_called_once_with("valid_token", "http://api.gitlab.com")
+        mock_check_ollama.assert_called_once_with("test_model")
+        mock_generate_embeddings.assert_called_once()
+        mock_execute_command.assert_called_once()
+
+
+def test_error_handling_invalid_credentials(runner):
+    with patch("demo.main.check_gitlab_credentials", side_effect=Exception("Invalid credentials")), \
+         patch("demo.main.print") as mock_print:
+
+        result = runner.invoke(demo, [
+            "--api-base", "http://api.gitlab.com",
+            "--access-token", "invalid_token"
+        ])
+
+        assert result.exit_code != 0

uis-sprint-report-0.1.0/tests/test_embeddings.py

@@ -0,0 +1,32 @@
+import pytest
+from unittest.mock import patch, MagicMock
+from demo.embeddings import generate_embeddings
+from langchain_huggingface import HuggingFaceEmbeddings
+
+
+def test_generate_embeddings_integration():
+    embedding_model = HuggingFaceEmbeddings()
+    with patch("demo.embeddings.get_gitlab_issues") as mock_get_gitlab_issues, \
+            patch("demo.utils.manage_cache_file") as mock_manage_cache, \
+            patch("langchain_community.document_loaders.TextLoader") as mock_text_loader, \
+            patch("langchain_text_splitters.CharacterTextSplitter") as mock_splitter:
+        mock_issue = MagicMock(attributes={'title': 'Bug Fix', 'description': 'Fix a critical bug'})
+        mock_get_gitlab_issues.return_value = [mock_issue]
+        mock_text_loader.return_value.load.return_value = "Bug Fix Fix a critical bug"
+        mock_splitter.return_value.split_documents.return_value = ["Bug Fix", "Fix a critical bug"]
+
+        result = generate_embeddings(
+            api_base="http://api.gitlab.com",
+            access_token="valid_token",
+            labels="bug",
+            group_id=123,
+            iteration_id=456,
+            cache_file=".cache",
+            chunk_size=100,
+            chunk_overlap=20,
+            embedding_model=embedding_model,
+            sprint_goals="Complete all tasks"
+        )
+
+        mock_get_gitlab_issues.assert_called_once_with("valid_token", "http://api.gitlab.com", 123, "bug", 456)
+        assert result is not None

uis-sprint-report-0.1.0/tests/test_utils.py

@@ -0,0 +1,33 @@
+import pytest
+from unittest.mock import patch
+from demo.utils import check_gitlab_credentials, check_ollama
+
+def test_check_gitlab_credentials_valid():
+    with patch("demo.utils.check_access", return_value=True), patch("demo.utils.print") as mock_print:
+        check_gitlab_credentials("valid_token", "http://gitlab.com")
+        mock_print.assert_called_with("[green]GitLab credentials are valid[/green]")
+
+def test_check_gitlab_credentials_invalid():
+    with patch("demo.utils.check_access", return_value=False), patch("demo.utils.print") as mock_print:
+        with pytest.raises(Exception) as exc_info:
+            check_gitlab_credentials("invalid_token", "http://gitlab.com")
+        assert str(exc_info.value) == "Invalid GitLab credentials"
+        mock_print.assert_called_with("[red]Invalid GitLab credentials[/red]")
+
+def test_check_ollama_valid_model():
+    with patch("ollama.list", return_value={'models': [{'name': 'test_model'}]}), patch("demo.utils.print") as mock_print:
+        check_ollama(model="test_model")
+        mock_print.assert_called_with("[green]Ollama model is valid[/green]")
+
+def test_check_ollama_invalid_model():
+    with patch("ollama.list", return_value={'models': [{'name': 'test_model'}]}), patch("demo.utils.print") as mock_print:
+        with pytest.raises(Exception) as exc_info:
+            check_ollama(model="invalid_model")
+        assert str(exc_info.value) == "Ollama is not running"
+
+def test_check_ollama_service_down():
+    with patch("ollama.list", side_effect=Exception("Service Down")), patch("demo.utils.print") as mock_print:
+        with pytest.raises(Exception) as exc_info:
+            check_ollama()
+        assert str(exc_info.value) == "Ollama is not running"
+        mock_print.assert_called_with("[red]Ollama is not running. Error: Service Down[/red]")

uis-sprint-report-0.1.0/uis_sprint_report.egg-info/PKG-INFO

@@ -0,0 +1,80 @@
+Metadata-Version: 2.1
+Name: uis-sprint-report
+Version: 0.1.0
+Summary: A Python package for generating sprint reports and managing sprint activities at University Information Services.
+Home-page: https://gitlab.developers.cam.ac.uk/ee345/demo
+Author: Eugene Evstafev
+Author-email: ee345@cam.ac.uk
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# Project Overview
+
+This project leverages the capabilities of the LangChain library to interact with GitLab issues and generate sprint report presentations. The system retrieves issue data from a specified GitLab group, processes the information, and summarizes the status of sprint goals in a PowerPoint presentation.
+
+## Features
+
+- Retrieve issues from GitLab using a specific label and iteration ID.
+- Analyze and categorize issues based on sprint goals.
+- Generate summaries and status reports for sprint goals.
+- Create PowerPoint presentations to visually present the sprint report.
+
+## Prerequisites
+
+Before you can run this project, you need to have Python installed on your machine. Python 3.6 or higher is recommended. You also need to ensure that Git is installed if you need to clone the repository.
+
+## Installation
+
+1. **Clone the Repository**:
+   ```bash
+   git clone https://gitlab.developers.cam.ac.uk/ee345/demo.git
+   cd demo
+   ```
+
+2. **Install Required Libraries**:
+   Ensure you have `pip` installed and then run:
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+3. **Download and Setup Ollama Model**:
+   Download the Ollama model from [Ollama Download](https://ollama.com/download) and [Mistral Model](https://ollama.com/library/mistral). Follow the instructions on the Ollama website for setting up the model.
+
+## Usage
+
+To run the script, use the following command. Replace the placeholder values with actual data like the GitLab access token and other parameters as required:
+
+```bash
+python main.py --token YOUR_GITLAB_ACCESS_TOKEN --gitlab_url https://gitlab.developers.cam.ac.uk/api/v4 --iteration_id=368 --goals "Front End Error Reporting,Gain access to account data (held in Entra ID and in our own systems) to start to understand user breakdown/profiles between Raven/Azure"
+```
+
+### Parameters Description
+
+- `--token`: GitLab access token for authentication. This is necessary to access the GitLab API securely.
+- `--gitlab_url`: The base URL of your GitLab instance API. Default is `https://gitlab.developers.cam.ac.uk/api/v4`.
+- `--group_id`: The ID of the GitLab group from which issues are to be fetched. Default is `5`.
+- `--labels`: URL-encoded string of labels used to filter issues by specific criteria. Default is `team%3A%3AIdentity`.
+- `--iteration_id`: The ID of the specific iteration to filter issues relevant to a particular sprint. Leave empty if not using iteration-based filtering.
+- `--goals`: A comma-separated list of sprint goals to analyze. Each goal should be clearly defined.
+- `--presentation_name`: The name of the output PowerPoint file where the sprint report will be saved. Default is `demo.pptx`.
+- `--chunk_size`: The size of text chunks in characters when splitting documents for processing. Default is `500`.
+- `--chunk_overlap`: The overlap of text chunks in characters when splitting documents. Default is `0`.
+- `--search_type`: The type of search to perform when retrieving documents. Default is `mmr` which stands for Maximal Marginal Relevance.
+- `--search_kwargs`: Additional keyword arguments in JSON format to configure the search behavior. Default is `{"k": 8}`, where `k` is the number of documents to retrieve.
+- `--cache_folder`: The directory to use for caching data such as embeddings. Default is `cache`.
+- `--model`: The language model to use, specified by name. Default is `mistral`.
+- `--max_tokens`: The maximum number of tokens to generate from the language model in a single request. Default is `1500`.
+
+## Contributing
+
+Contributions are welcome! For major changes, please open an issue first to discuss what you would like to change.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE) file for details.

uis-sprint-report-0.1.0/uis_sprint_report.egg-info/SOURCES.txt

@@ -0,0 +1,20 @@
+LICENSE
+README.md
+setup.py
+demo/__init__.py
+demo/config.py
+demo/demo.py
+demo/embeddings.py
+demo/main.py
+demo/models.py
+demo/prompts.py
+demo/utils.py
+tests/__init__.py
+tests/test_demo.py
+tests/test_embeddings.py
+tests/test_utils.py
+uis_sprint_report.egg-info/PKG-INFO
+uis_sprint_report.egg-info/SOURCES.txt
+uis_sprint_report.egg-info/dependency_links.txt
+uis_sprint_report.egg-info/requires.txt
+uis_sprint_report.egg-info/top_level.txt

uis-sprint-report-0.1.0/uis_sprint_report.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

uis-sprint-report-0.1.0/uis_sprint_report.egg-info/requires.txt

@@ -0,0 +1,14 @@
+click>=8.1.7
+rich>=13.7.1
+python-pptx>=0.6.23
+huggingface-hub==0.23.4
+langchain==0.2.6
+langchain-community==0.2.6
+langchain-core==0.2.10
+langchain-huggingface==0.0.3
+langchain-text-splitters==0.2.2
+faiss-cpu>=1.8.0
+pydantic>=2.7.4
+scikit-learn>=0.24.1
+torch>=1.9.0
+transformers>=4.42.3

uis-sprint-report-0.1.0/uis_sprint_report.egg-info/top_level.txt

@@ -0,0 +1,2 @@
+demo
+tests