uis-sprint-report 0.1.0__tar.gz → 0.1.1__tar.gz

uis-sprint-report-0.1.1/PKG-INFO

@@ -0,0 +1,83 @@
+Metadata-Version: 2.1
+Name: uis-sprint-report
+Version: 0.1.1
+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
+
+[![PyPI version](https://badge.fury.io/py/uis-sprint-report.svg)](https://badge.fury.io/py/uis-sprint-report)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
+[![Downloads](https://static.pepy.tech/badge/uis-sprint-report)](https://pepy.tech/project/uis-sprint-report)
+
+# UIS Sprint Report
+
+`UIS Sprint Report` is a command-line tool designed to generate detailed reports for sprint activities, manage sprint-related data through embeddings, and interact via a chat interface, specifically tailored for University Information Services.
+
+## Installation
+
+To install `UIS Sprint Report`, you can use pip:
+
+```bash
+pip install uis-sprint-report
+```
+
+Ensure that the Ollama local model server is running and that you have downloaded the necessary models locally before running this command-line tool.
+
+## Usage
+
+The tool is intended to be run with various commands based on the required operation: generating reports, creating PowerPoint presentations of sprint goals, or engaging in an interactive chat to query sprint statuses.
+
+### Command-Line Interface
+
+```bash
+uis-sprint-report --access-token "YOUR_TOKEN" --command "pptx" --sprint-goals "Goal 1; Goal 2"
+```
+
+### Input Parameters
+
+- `--api-base` (`str`): Base URL for API access. Default is `"https://gitlab.developers.cam.ac.uk/"`.
+- `--access-token` (`str`): Access token for API authentication.
+- `--command` (`str`): Command to execute. Options are `"report"`, `"pptx"`, or `"chat"`.
+- `--group-id` (`int`): GitLab group ID. Default is `5`.
+- `--iteration-id` (`int`): Iteration ID within the group. Default is `383`.
+- `--labels` (`str`): Labels to filter the issues. Default is `"team::Identity"`.
+- `--model` (`str`): Ollama model to use. Default is `"mistral:latest"`.
+- `--cache-file` (`str`): Path to the cache file. Default is `".cache"`.
+- `--chunk-size` (`int`): Size of the text chunks for processing. Default is `500`.
+- `--chunk-overlap` (`int`): Overlap between text chunks. Default is `0`.
+- `--max-tokens` (`int`): Maximum tokens for model inference. Default is `1500`.
+- `--sprint-goals` (`str`): Description of sprint goals.
+- `--pptx-file` (`str`): Path for saving the generated PowerPoint file. Default is `"../sprint_goals.pptx"`.
+- `--max-attempts` (`int`): Maximum attempts for generating a response. Default is `5`.
+
+### Commands
+
+- **report**: Generates a JSON report detailing the sprint activities.
+- **pptx**: Creates a PowerPoint presentation based on sprint activities and goals.
+- **chat**: Starts an interactive chat session for querying sprint data.
+
+Each command initializes the `ChatOllama` model with the specified `model` and `max_tokens`, then executes the function corresponding to the command.
+
+## Features
+
+- Integrated report generation from GitLab issues.
+- PowerPoint presentation creation for sprint reviews.
+- Interactive chat functionality for live sprint data querying.
+- Supports local execution with Ollama models for enhanced data privacy and control.
+
+## Contributing
+
+Contributions, issues, and feature requests are welcome! Feel free to check the [issues page](https://gitlab.developers.cam.ac.uk/ee345/demo/issues).
+
+## License
+
+This project is licensed under the [MIT License](https://choosealicense.com/licenses/mit/).

uis-sprint-report-0.1.1/README.md

@@ -0,0 +1,67 @@
+[![PyPI version](https://badge.fury.io/py/uis-sprint-report.svg)](https://badge.fury.io/py/uis-sprint-report)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
+[![Downloads](https://static.pepy.tech/badge/uis-sprint-report)](https://pepy.tech/project/uis-sprint-report)
+
+# UIS Sprint Report
+
+`UIS Sprint Report` is a command-line tool designed to generate detailed reports for sprint activities, manage sprint-related data through embeddings, and interact via a chat interface, specifically tailored for University Information Services.
+
+## Installation
+
+To install `UIS Sprint Report`, you can use pip:
+
+```bash
+pip install uis-sprint-report
+```
+
+Ensure that the Ollama local model server is running and that you have downloaded the necessary models locally before running this command-line tool.
+
+## Usage
+
+The tool is intended to be run with various commands based on the required operation: generating reports, creating PowerPoint presentations of sprint goals, or engaging in an interactive chat to query sprint statuses.
+
+### Command-Line Interface
+
+```bash
+uis-sprint-report --access-token "YOUR_TOKEN" --command "pptx" --sprint-goals "Goal 1; Goal 2"
+```
+
+### Input Parameters
+
+- `--api-base` (`str`): Base URL for API access. Default is `"https://gitlab.developers.cam.ac.uk/"`.
+- `--access-token` (`str`): Access token for API authentication.
+- `--command` (`str`): Command to execute. Options are `"report"`, `"pptx"`, or `"chat"`.
+- `--group-id` (`int`): GitLab group ID. Default is `5`.
+- `--iteration-id` (`int`): Iteration ID within the group. Default is `383`.
+- `--labels` (`str`): Labels to filter the issues. Default is `"team::Identity"`.
+- `--model` (`str`): Ollama model to use. Default is `"mistral:latest"`.
+- `--cache-file` (`str`): Path to the cache file. Default is `".cache"`.
+- `--chunk-size` (`int`): Size of the text chunks for processing. Default is `500`.
+- `--chunk-overlap` (`int`): Overlap between text chunks. Default is `0`.
+- `--max-tokens` (`int`): Maximum tokens for model inference. Default is `1500`.
+- `--sprint-goals` (`str`): Description of sprint goals.
+- `--pptx-file` (`str`): Path for saving the generated PowerPoint file. Default is `"../sprint_goals.pptx"`.
+- `--max-attempts` (`int`): Maximum attempts for generating a response. Default is `5`.
+
+### Commands
+
+- **report**: Generates a JSON report detailing the sprint activities.
+- **pptx**: Creates a PowerPoint presentation based on sprint activities and goals.
+- **chat**: Starts an interactive chat session for querying sprint data.
+
+Each command initializes the `ChatOllama` model with the specified `model` and `max_tokens`, then executes the function corresponding to the command.
+
+## Features
+
+- Integrated report generation from GitLab issues.
+- PowerPoint presentation creation for sprint reviews.
+- Interactive chat functionality for live sprint data querying.
+- Supports local execution with Ollama models for enhanced data privacy and control.
+
+## Contributing
+
+Contributions, issues, and feature requests are welcome! Feel free to check the [issues page](https://gitlab.developers.cam.ac.uk/ee345/demo/issues).
+
+## License
+
+This project is licensed under the [MIT License](https://choosealicense.com/licenses/mit/).

{uis-sprint-report-0.1.0 → uis-sprint-report-0.1.1}/setup.py

@@ -3,7 +3,7 @@ from setuptools import setup, find_packages
 
 setup(
     name='uis-sprint-report',
-    version='0.1.0',
+    version='0.1.1',
     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.',

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

@@ -0,0 +1,83 @@
+Metadata-Version: 2.1
+Name: uis-sprint-report
+Version: 0.1.1
+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
+
+[![PyPI version](https://badge.fury.io/py/uis-sprint-report.svg)](https://badge.fury.io/py/uis-sprint-report)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
+[![Downloads](https://static.pepy.tech/badge/uis-sprint-report)](https://pepy.tech/project/uis-sprint-report)
+
+# UIS Sprint Report
+
+`UIS Sprint Report` is a command-line tool designed to generate detailed reports for sprint activities, manage sprint-related data through embeddings, and interact via a chat interface, specifically tailored for University Information Services.
+
+## Installation
+
+To install `UIS Sprint Report`, you can use pip:
+
+```bash
+pip install uis-sprint-report
+```
+
+Ensure that the Ollama local model server is running and that you have downloaded the necessary models locally before running this command-line tool.
+
+## Usage
+
+The tool is intended to be run with various commands based on the required operation: generating reports, creating PowerPoint presentations of sprint goals, or engaging in an interactive chat to query sprint statuses.
+
+### Command-Line Interface
+
+```bash
+uis-sprint-report --access-token "YOUR_TOKEN" --command "pptx" --sprint-goals "Goal 1; Goal 2"
+```
+
+### Input Parameters
+
+- `--api-base` (`str`): Base URL for API access. Default is `"https://gitlab.developers.cam.ac.uk/"`.
+- `--access-token` (`str`): Access token for API authentication.
+- `--command` (`str`): Command to execute. Options are `"report"`, `"pptx"`, or `"chat"`.
+- `--group-id` (`int`): GitLab group ID. Default is `5`.
+- `--iteration-id` (`int`): Iteration ID within the group. Default is `383`.
+- `--labels` (`str`): Labels to filter the issues. Default is `"team::Identity"`.
+- `--model` (`str`): Ollama model to use. Default is `"mistral:latest"`.
+- `--cache-file` (`str`): Path to the cache file. Default is `".cache"`.
+- `--chunk-size` (`int`): Size of the text chunks for processing. Default is `500`.
+- `--chunk-overlap` (`int`): Overlap between text chunks. Default is `0`.
+- `--max-tokens` (`int`): Maximum tokens for model inference. Default is `1500`.
+- `--sprint-goals` (`str`): Description of sprint goals.
+- `--pptx-file` (`str`): Path for saving the generated PowerPoint file. Default is `"../sprint_goals.pptx"`.
+- `--max-attempts` (`int`): Maximum attempts for generating a response. Default is `5`.
+
+### Commands
+
+- **report**: Generates a JSON report detailing the sprint activities.
+- **pptx**: Creates a PowerPoint presentation based on sprint activities and goals.
+- **chat**: Starts an interactive chat session for querying sprint data.
+
+Each command initializes the `ChatOllama` model with the specified `model` and `max_tokens`, then executes the function corresponding to the command.
+
+## Features
+
+- Integrated report generation from GitLab issues.
+- PowerPoint presentation creation for sprint reviews.
+- Interactive chat functionality for live sprint data querying.
+- Supports local execution with Ollama models for enhanced data privacy and control.
+
+## Contributing
+
+Contributions, issues, and feature requests are welcome! Feel free to check the [issues page](https://gitlab.developers.cam.ac.uk/ee345/demo/issues).
+
+## License
+
+This project is licensed under the [MIT License](https://choosealicense.com/licenses/mit/).

uis-sprint-report-0.1.0/PKG-INFO

@@ -1,80 +0,0 @@
-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

@@ -1,64 +0,0 @@
-# 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/PKG-INFO

@@ -1,80 +0,0 @@
-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.