Merge pull request #3 from KjellKod/jira_metrics

Jira metrics

Author: KjellKod

README.txt

@@ -0,0 +1,93 @@
+import os
+import requests
+from collections import defaultdict
+
+# Retrieve the access token from the environment variable
+access_token = os.environ.get('GITHUB_TOKEN_READONLY_WEB')
+
+# Set the repository owner and name
+owner = os.environ.get('GITHUB_METRIC_OWNER')
+repo = on.environ.get('GITHUB_METRIC_REPO')
+
+# Set the API endpoint URL
+url = f'https://api.github.com/repos/{owner}/{repo}/tags'
+
+# Set the request headers
+headers = {
+    'Authorization': f'token {access_token}',
+    'Accept': 'application/vnd.github.v3+json'
+}
+
+# Set the query parameters
+params = {
+    'per_page': 100,  # Number of items per page
+    'since': '2022-12-31T23:59:59Z'  # Filter releases after 2023-12
+}
+
+# Create a dictionary to store releases by year and month
+releases_by_month = defaultdict(list)
+
+# Retrieve releases from all pages
+while url:
+    # Send a GET request to retrieve the tags
+    response = requests.get(url, headers=headers, params=params)
+
+    # Check if the request was successful
+    if response.status_code == 200:
+        # Parse the JSON response
+        tags = response.json()
+
+        # Sort the releases into the dictionary
+        for tag in tags:
+            if tag['name'].startswith('release-'):
+                release_date = tag['name'].split('release-')[1]
+                year_month = release_date[:7]
+                releases_by_month[year_month].append(tag['name'])
+
+        # Check if there are more pages
+        if 'next' in response.links:
+            url = response.links['next']['url']
+        else:
+            url = None
+    else:
+        print(f'Error: {response.status_code} - {response.text}')
+        break
+
+# Print the releases enumerated by year and month with the month sum
+for year_month, releases in sorted(releases_by_month.items()):
+    year, month = year_month.split('-')
+    month_sum = len(releases)
+    print(f"{year}-{month}: {month_sum}")
+    for index, release in enumerate(releases, start=1):
+        print(f"  {index}. {release}")
+    print()
+
+
+# # Send a GET request to retrieve the tags
+# response = requests.get(url, headers=headers)
+
+# # Check if the request was successful
+# if response.status_code == 200:
+#     # Parse the JSON response
+#     tags = response.json()
+
+#     # Create a dictionary to store releases by year and month
+#     releases_by_month = defaultdict(list)
+
+#     # Sort the releases into the dictionary
+#     for tag in tags:
+#         if tag['name'].startswith('release-'):
+#             release_date = tag['name'].split('release-')[1]
+#             year_month = release_date[:7]
+#             releases_by_month[year_month].append(tag['name'])
+
+#     # Print the releases enumerated by year and month
+#     for year_month, releases in sorted(releases_by_month.items()):
+#         year, month = year_month.split('-')
+#         month_sum = len(releases)
+#         print(f"{year}-{month}: {month_sum}")
+#         for index, release in enumerate(releases, start=1):
+#             print(f"  {index}. {release}")
+#         print()
+# else:
+#     print(f'Error: {response.status_code} - {response.text}')

github/releases.py

@@ -0,0 +1,67 @@
+install the jiradoodles package in edit mode will fix unit test issues
+=====================
+pip install -e .
+
+run unit test
+============
+python3 -m unittest discover -s test
+
+
+
+
+jira_metrics/
+│
+├── bin/                    # Directory for executable scripts
+│   ├── extract_metadata.py
+│   ├── extract_performance.py
+│   └── ...
+│
+├── jira_metrics/           # Main package directory
+│   ├── __init__.py         # Makes jira_metrics a Python package
+│   ├── config.py           # Configuration settings and constants
+│   ├── utilities/          # Utility modules
+│   │   ├── __init__.py
+│   │   ├── time_utils.py
+│   │   ├── io_utils.py
+│   │   ├── json_utils.py
+│   │   ├── jira_query.py
+│   │   └── ...
+│   ├── metrics/            # Modules for specific metrics extraction
+│   │   ├── __init__.py
+
+│   │   ├── sprint_metadata.py
+│   │   ├── performance_metrics.py
+│   │   └── ...
+│   └── data/               # For storing local data files, if necessary
+│
+├── tests/                  # Test suite
+│   ├── __init__.py
+│   ├── test_time_utils.py
+│   ├── test_io_utils.py
+│   ├── test_json_utils.py
+│   ├── test_jira_query.py
+│   └── ...
+│
+├── .gitignore              # Specifies intentionally untracked files to ignore
+├── requirements.txt        # Fixed versions of dependencies
+└── README.md               # Project overview and setup instructions
+
+
+Key Components
+bin/: This directory contains executable scripts that users can run. Each script uses functionalities from the jira_metrics package. These scripts are the entry points for different tasks like extracting metadata or performance metrics.
+jira_metrics/: The main package containing all the modular code.
+config.py: Central configuration file for managing constants like API keys, URLs, etc.
+utilities/: Utility modules that provide common functionalities like handling time and dates, I/O operations, and Jira queries.
+metrics/: Modules dedicated to extracting specific metrics from Jira.
+tests/: Contains all unit tests. Each utility and metrics module should have corresponding test modules here.
+
+Development Practices
+Modularity: Keep the code modular. Each utility should have a single responsibility and should be independent as much as possible.
+Testing: Aim for high test coverage. Mock external dependencies like Jira API responses.
+Documentation: Each module, class, and method should have clear docstrings explaining what it does. The README should provide clear setup and usage instructions.
+Version Control: Use Git for version control. Include a .gitignore file to exclude unnecessary files (like __pycache__).
+
+Setup Files
+init_.py: Necessary in each directory that you want to treat as a Python package. This can be empty or can include package imports.
+requirements.txt: List all the dependencies with versions that are known to work with your application.
+This structure should provide a solid foundation for building and scaling your Jira metrics extraction tool while keeping the code organized and maintainable.

jira/README.md

@@ -0,0 +1,36 @@
+import os
+import json
+from jira import JIRA
+#from jira_metrics.utilities.jira_query import create_jql_query
+
+def setup_jira_instance():
+    jira_api_key = os.getenv("JIRA_API_KEY")
+    jira_link = os.getenv("JIRA_LINK")
+    user_email = os.getenv("USER_EMAIL")
+
+    if not all([jira_api_key, jira_link, user_email]):
+        raise EnvironmentError("Missing one or more environment variables: JIRA_API_KEY, JIRA_LINK, USER_EMAIL")
+
+    options = {'server': jira_link}
+    jira = JIRA(options, basic_auth=(user_email, jira_api_key))
+    return jira
+
+def read_queries_from_file(file_path):
+    with open(file_path, 'r') as file:
+        queries = json.load(file)
+    return queries
+
+def fetch_tickets(jira, query):
+    issues = jira.search_issues(query, maxResults=-1)
+    return issues
+
+def main():
+    jira = setup_jira_instance()
+    queries = read_queries_from_file('queries/queries.json')
+
+    for query in queries:
+        issues = fetch_tickets(jira, query['jql'])
+        print(f"Found {len(issues)} issues for query: {query['description']}")
+
+if __name__ == "__main__":
+    main()