[](https://badge.fury.io/py/uis-sprint-report)
[](https://opensource.org/licenses/MIT)
[](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 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/).
Raw data
{
"_id": null,
"home_page": "https://gitlab.developers.cam.ac.uk/ee345/demo",
"name": "uis-sprint-report",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": "Eugene Evstafev",
"author_email": "ee345@cam.ac.uk",
"download_url": "https://files.pythonhosted.org/packages/bb/77/9ce8e97078dfe1c5b3c13932588589dc92dde4f65d7c794ae0cbb123e5b4/uis-sprint-report-0.1.10.tar.gz",
"platform": null,
"description": "[](https://badge.fury.io/py/uis-sprint-report)\n[](https://opensource.org/licenses/MIT)\n[](https://pepy.tech/project/uis-sprint-report)\n\n# UIS Sprint Report\n\n`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.\n\n## Installation\n\nTo install `UIS Sprint Report`, you can use pip:\n\n```bash\npip install uis-sprint-report\n```\n\nEnsure that the Ollama local model server is running and that you have downloaded the necessary models locally before running this command-line tool.\n\n## Usage\n\nThe 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.\n\n### Command-Line Interface\n\n```bash\nuis-sprint-report --access-token \"YOUR_TOKEN\" --command \"pptx\" --sprint-goals \"Goal 1; Goal 2\"\n```\n\n### Input Parameters\n\n- `--api-base` (`str`): Base URL for API access. Default is `\"https://gitlab.developers.cam.ac.uk/\"`.\n- `--access-token` (`str`): Access token for API authentication.\n- `--command` (`str`): Command to execute. Options are `\"report\"`, `\"pptx\"`, or `\"chat\"`.\n- `--group-id` (`int`): GitLab group ID. Default is `5`.\n- `--iteration-id` (`int`): Iteration ID within the group. Default is `383`.\n- `--labels` (`str`): Labels to filter the issues. Default is `\"team::Identity\"`.\n- `--model` (`str`): Ollama model to use. Default is `\"mistral:latest\"`.\n- `--cache-file` (`str`): Path to the cache file. Default is `\".cache\"`.\n- `--chunk-size` (`int`): Size of the text chunks for processing. Default is `500`.\n- `--chunk-overlap` (`int`): Overlap between text chunks. Default is `0`.\n- `--max-tokens` (`int`): Maximum tokens for model inference. Default is `1500`.\n- `--sprint-goals` (`str`): Description of sprint goals.\n- `--pptx-file` (`str`): Path for saving the generated PowerPoint file. Default is `\"sprint_goals.pptx\"`.\n- `--max-attempts` (`int`): Maximum attempts for generating a response. Default is `5`.\n\n### Commands\n\n- **report**: Generates a report detailing the sprint activities.\n- **pptx**: Creates a PowerPoint presentation based on sprint activities and goals.\n- **chat**: Starts an interactive chat session for querying sprint data.\n\nEach command initializes the `ChatOllama` model with the specified `model` and `max_tokens`, then executes the function corresponding to the command.\n\n## Features\n\n- Integrated report generation from GitLab issues.\n- PowerPoint presentation creation for sprint reviews.\n- Interactive chat functionality for live sprint data querying.\n- Supports local execution with Ollama models for enhanced data privacy and control.\n\n## Contributing\n\nContributions, issues, and feature requests are welcome! Feel free to check the [issues page](https://gitlab.developers.cam.ac.uk/ee345/demo/issues).\n\n## License\n\nThis project is licensed under the [MIT License](https://choosealicense.com/licenses/mit/).\n",
"bugtrack_url": null,
"license": null,
"summary": "A Python package for generating sprint reports and managing sprint activities at University Information Services.",
"version": "0.1.10",
"project_urls": {
"Homepage": "https://gitlab.developers.cam.ac.uk/ee345/demo"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ec5654beac9103b5986de68c88d89d04a2c480240ba53041a017f3b9963b99e3",
"md5": "744b388256eacebc869f48adcd16a61e",
"sha256": "51c0cad1171de8dc02a41edb4ff17131c67f329bdb03c2665239e4369bc28354"
},
"downloads": -1,
"filename": "uis_sprint_report-0.1.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "744b388256eacebc869f48adcd16a61e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 14808,
"upload_time": "2024-07-06T07:34:20",
"upload_time_iso_8601": "2024-07-06T07:34:20.741756Z",
"url": "https://files.pythonhosted.org/packages/ec/56/54beac9103b5986de68c88d89d04a2c480240ba53041a017f3b9963b99e3/uis_sprint_report-0.1.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bb779ce8e97078dfe1c5b3c13932588589dc92dde4f65d7c794ae0cbb123e5b4",
"md5": "7dad2a55fbceb5e2898b585b7e7b10e6",
"sha256": "4fc1112ef9f3db7e3245b411e5e2ca87204820942118a087cd0fab5f7f92887b"
},
"downloads": -1,
"filename": "uis-sprint-report-0.1.10.tar.gz",
"has_sig": false,
"md5_digest": "7dad2a55fbceb5e2898b585b7e7b10e6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 12759,
"upload_time": "2024-07-06T07:34:25",
"upload_time_iso_8601": "2024-07-06T07:34:25.640066Z",
"url": "https://files.pythonhosted.org/packages/bb/77/9ce8e97078dfe1c5b3c13932588589dc92dde4f65d7c794ae0cbb123e5b4/uis-sprint-report-0.1.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-06 07:34:25",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "uis-sprint-report"
}
JSON