admin-toolbox 0.1.0__tar.gz

admin_toolbox-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Przemyslaw Sagalo
+
+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.

admin_toolbox-0.1.0/PKG-INFO

@@ -0,0 +1,52 @@
+Metadata-Version: 2.4
+Name: admin-toolbox
+Version: 0.1.0
+Summary: A collection of administration utility tools for various services.
+Author: przemek@sagalo.pro
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: jira==3.8.0
+Requires-Dist: click==8.1.7
+Requires-Dist: python-dotenv==1.0.1
+Dynamic: license-file
+
+# Admin Toolbox
+
+A collection of administration utility tools for various services.
+
+## Installation
+
+```bash
+pip install admin-toolbox
+```
+
+## Environment Variables
+
+The following environment variables must be set (either in your environment or in a `.env` file):
+
+- `JIRA_URL`: The full URL to your Jira instance (e.g., `https://yourdomain.atlassian.net`).
+- `JIRA_PAT`: Your Personal Access Token for authentication.
+
+## Usage
+
+### Jira Issue Report
+
+Generates a Markdown report of Jira issues assigned to the current user, grouped by status.
+
+**Behavior:**
+- Includes all issues that are currently in an **open** state (not Done/Cancelled).
+- Includes issues in a **closed** state (Done) ONLY if they were resolved within the specified date range.
+- Excludes all issues in the **Cancelled** status.
+
+```bash
+admin-toolbox jira-report --projects PROJ1 --projects PROJ2 --start-date 2024-01-01 --end-date 2024-03-31
+```
+
+**Options:**
+
+- `--projects`, `-p`: (Required) List of Jira project keys to include. Can be specified multiple times.
+- `--start-date`: (Optional) Start date for filtering closed/resolved tasks in `YYYY-MM-DD` format. Defaults to the first day of the current month.
+- `--end-date`: (Optional) End date for filtering closed/resolved tasks in `YYYY-MM-DD` format. Defaults to the last day (Sunday) of the current week.
+- `--output`, `-o`: (Optional) Output Markdown file name. Defaults to `jira_report.md`.
+

admin_toolbox-0.1.0/README.md

@@ -0,0 +1,39 @@
+# Admin Toolbox
+
+A collection of administration utility tools for various services.
+
+## Installation
+
+```bash
+pip install admin-toolbox
+```
+
+## Environment Variables
+
+The following environment variables must be set (either in your environment or in a `.env` file):
+
+- `JIRA_URL`: The full URL to your Jira instance (e.g., `https://yourdomain.atlassian.net`).
+- `JIRA_PAT`: Your Personal Access Token for authentication.
+
+## Usage
+
+### Jira Issue Report
+
+Generates a Markdown report of Jira issues assigned to the current user, grouped by status.
+
+**Behavior:**
+- Includes all issues that are currently in an **open** state (not Done/Cancelled).
+- Includes issues in a **closed** state (Done) ONLY if they were resolved within the specified date range.
+- Excludes all issues in the **Cancelled** status.
+
+```bash
+admin-toolbox jira-report --projects PROJ1 --projects PROJ2 --start-date 2024-01-01 --end-date 2024-03-31
+```
+
+**Options:**
+
+- `--projects`, `-p`: (Required) List of Jira project keys to include. Can be specified multiple times.
+- `--start-date`: (Optional) Start date for filtering closed/resolved tasks in `YYYY-MM-DD` format. Defaults to the first day of the current month.
+- `--end-date`: (Optional) End date for filtering closed/resolved tasks in `YYYY-MM-DD` format. Defaults to the last day (Sunday) of the current week.
+- `--output`, `-o`: (Optional) Output Markdown file name. Defaults to `jira_report.md`.
+

admin_toolbox-0.1.0/pyproject.toml

@@ -0,0 +1,23 @@
+[project]
+name = "admin-toolbox"
+version = "0.1.0"
+description = "A collection of administration utility tools for various services."
+authors = [
+    {name = "przemek@sagalo.pro"}
+]
+readme = "README.md"
+
+requires-python = ">=3.11"
+
+dependencies = [
+    "jira==3.8.0",
+    "click==8.1.7",
+    "python-dotenv==1.0.1"
+]
+
+[project.scripts]
+admin-toolbox = "admin_toolbox.cli:main"
+
+[build-system]
+requires = ["setuptools >= 79.0.1"]
+build-backend = "setuptools.build_meta"

admin_toolbox-0.1.0/setup.cfg

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

admin_toolbox-0.1.0/src/admin_toolbox/cli.py

@@ -0,0 +1,39 @@
+import click
+from datetime import datetime, timedelta
+from dotenv import load_dotenv
+from admin_toolbox.jira_report import fetch_and_export_jira_issues
+
+# Load environment variables from .env file
+load_dotenv()
+
+@click.group()
+def main():
+    """Admin Toolbox - A collection of utility tools."""
+    pass
+
+@main.command()
+@click.option('--start-date', type=str, help='Start date for filtering CLOSED tasks (resolved >= date) in YYYY-MM-DD format (default: 1st of current month)')
+@click.option('--end-date', type=str, help='End date for filtering CLOSED tasks (resolved <= date) in YYYY-MM-DD format (default: end of current week)')
+@click.option('--projects', '-p', multiple=True, required=True, help='Jira project keys/names to include')
+@click.option('--output', '-o', default='jira_report.md', help='Output Markdown file name')
+def jira_report(start_date, end_date, projects, output):
+    """Generate a status-grouped Jira issues report. 
+    Includes all assigned open tasks and closed tasks resolved within the specified date range.
+    """
+    
+    today = datetime.now()
+    if not start_date:
+        start_date = today.replace(day=1).strftime('%Y-%m-%d')
+    if not end_date:
+        # Calculate the end of the current week (Sunday)
+        end_of_week = today + timedelta(days=(6 - today.weekday()))
+        end_date = end_of_week.strftime('%Y-%m-%d')
+
+    try:
+        fetch_and_export_jira_issues(projects, start_date, end_date, output)
+        click.echo(f"Report successfully generated: {output}")
+    except Exception as e:
+        click.echo(f"Error: {e}", err=True)
+
+if __name__ == '__main__':
+    main()

admin_toolbox-0.1.0/src/admin_toolbox/jira_report.py

@@ -0,0 +1,46 @@
+import os
+from jira import JIRA
+
+def fetch_and_export_jira_issues(projects, start_date, end_date, output_file):
+    jira_url = os.environ.get('JIRA_URL')
+    jira_pat = os.environ.get('JIRA_PAT')
+
+    if not jira_url or not jira_pat:
+        raise ValueError("Environment variables JIRA_URL and JIRA_PAT must be set.")
+
+    # Authenticate with Jira
+    jira = JIRA(server=jira_url, token_auth=jira_pat)
+    
+    # Construct JQL query
+    project_list_str = ", ".join([f'"{p}"' for p in projects])
+    
+    # JQL with full filtration for open/closed tasks
+    jql = (
+        f'project in ({project_list_str}) AND '
+        f'assignee = currentUser() AND '
+        f'status != "Cancelled" AND '
+        f'(status != "Done" OR (status = "Done" AND resolutiondate >= "{start_date}" AND resolutiondate <= "{end_date} 23:59")) '
+        f'ORDER BY status ASC, created ASC'
+    )
+
+    # Fetch issues
+    issues = jira.search_issues(jql, maxResults=False)
+    
+    if not issues:
+        with open(output_file, 'w', encoding='utf-8') as f:
+            f.write("No issues found for the specified criteria.\n")
+        return
+
+    # Find the maximum status length for padding to ensure same size for all rows
+    max_status_len = max(len(issue.fields.status.name) for issue in issues)
+
+    # Write to Markdown file as a bulleted list
+    with open(output_file, 'w', encoding='utf-8') as f:
+        for issue in issues:
+            status = issue.fields.status.name
+            key = issue.key
+            summary = issue.fields.summary
+            
+            # Pad status for consistent width
+            padded_status = status.ljust(max_status_len)
+            f.write(f"- [{padded_status}] {key} - {summary}\n")

admin_toolbox-0.1.0/src/admin_toolbox.egg-info/PKG-INFO

@@ -0,0 +1,52 @@
+Metadata-Version: 2.4
+Name: admin-toolbox
+Version: 0.1.0
+Summary: A collection of administration utility tools for various services.
+Author: przemek@sagalo.pro
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: jira==3.8.0
+Requires-Dist: click==8.1.7
+Requires-Dist: python-dotenv==1.0.1
+Dynamic: license-file
+
+# Admin Toolbox
+
+A collection of administration utility tools for various services.
+
+## Installation
+
+```bash
+pip install admin-toolbox
+```
+
+## Environment Variables
+
+The following environment variables must be set (either in your environment or in a `.env` file):
+
+- `JIRA_URL`: The full URL to your Jira instance (e.g., `https://yourdomain.atlassian.net`).
+- `JIRA_PAT`: Your Personal Access Token for authentication.
+
+## Usage
+
+### Jira Issue Report
+
+Generates a Markdown report of Jira issues assigned to the current user, grouped by status.
+
+**Behavior:**
+- Includes all issues that are currently in an **open** state (not Done/Cancelled).
+- Includes issues in a **closed** state (Done) ONLY if they were resolved within the specified date range.
+- Excludes all issues in the **Cancelled** status.
+
+```bash
+admin-toolbox jira-report --projects PROJ1 --projects PROJ2 --start-date 2024-01-01 --end-date 2024-03-31
+```
+
+**Options:**
+
+- `--projects`, `-p`: (Required) List of Jira project keys to include. Can be specified multiple times.
+- `--start-date`: (Optional) Start date for filtering closed/resolved tasks in `YYYY-MM-DD` format. Defaults to the first day of the current month.
+- `--end-date`: (Optional) End date for filtering closed/resolved tasks in `YYYY-MM-DD` format. Defaults to the last day (Sunday) of the current week.
+- `--output`, `-o`: (Optional) Output Markdown file name. Defaults to `jira_report.md`.
+

admin_toolbox-0.1.0/src/admin_toolbox.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE
+README.md
+pyproject.toml
+src/admin_toolbox/__init__.py
+src/admin_toolbox/cli.py
+src/admin_toolbox/jira_report.py
+src/admin_toolbox.egg-info/PKG-INFO
+src/admin_toolbox.egg-info/SOURCES.txt
+src/admin_toolbox.egg-info/dependency_links.txt
+src/admin_toolbox.egg-info/entry_points.txt
+src/admin_toolbox.egg-info/requires.txt
+src/admin_toolbox.egg-info/top_level.txt

admin_toolbox-0.1.0/src/admin_toolbox.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

admin_toolbox-0.1.0/src/admin_toolbox.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+admin-toolbox = admin_toolbox.cli:main

admin_toolbox-0.1.0/src/admin_toolbox.egg-info/requires.txt

@@ -0,0 +1,3 @@
+jira==3.8.0
+click==8.1.7
+python-dotenv==1.0.1

admin_toolbox-0.1.0/src/admin_toolbox.egg-info/top_level.txt

@@ -0,0 +1 @@
+admin_toolbox