import requests
from requests.auth import HTTPBasicAuth
import json
from datetime import datetime
import sys
# ============================================================================
# CONFIGURATION - Update these variables with your Jira credentials
# ============================================================================
JIRA_URL = "" # Your Jira instance URL
JIRA_EMAIL = "" # Your Jira email address
JIRA_API_TOKEN = "" # Your Jira API token
# ============================================================================
def get_all_filters(jira_url, auth):
"""
Fetch all filters accessible to the user.
Args:
jira_url: Base Jira URL
auth: HTTPBasicAuth object
Returns:
List of filter dictionaries
"""
filters = []
start_at = 0
max_results = 50
while True:
# API endpoint to get filters
url = f"{jira_url}/rest/api/3/filter/search"
params = {
'startAt': start_at,
'maxResults': max_results,
'expand': 'jql,owner,sharePermissions'
}
try:
response = requests.get(url, auth=auth, params=params)
response.raise_for_status()
data = response.json()
filters.extend(data.get('values', []))
# Check if there are more results
if start_at + max_results >= data.get('total', 0):
break
start_at += max_results
except requests.exceptions.RequestException as e:
print(f"Error fetching filters: {e}", file=sys.stderr)
if hasattr(e, 'response') and e.response is not None:
print(f"Response: {e.response.text}", file=sys.stderr)
sys.exit(1)
return filters
def format_last_viewed(last_viewed):
"""
Format the last viewed timestamp.
Args:
last_viewed: ISO format timestamp string or None
Returns:
Formatted date string or 'Never'
"""
if not last_viewed:
return 'Never'
try:
dt = datetime.fromisoformat(last_viewed.replace('Z', '+00:00'))
return dt.strftime('%Y-%m-%d %H:%M:%S')
except Exception:
return last_viewed
def is_public_filter(filter_data):
"""
Check if a filter is shared publicly.
Args:
filter_data: Filter dictionary
Returns:
Boolean indicating if filter is public
"""
share_permissions = filter_data.get('sharePermissions', [])
for permission in share_permissions:
if permission.get('type') == 'global':
return True
return False
def print_filters_table(filters):
"""
Print filters in a formatted table.
Args:
filters: List of filter dictionaries
"""
if not filters:
print("No filters found.")
return
# Print header
print(f"\n{'ID':<10} {'Name':<40} {'Owner':<30} {'Public':<8} {'Last Viewed':<20}")
print("=" * 108)
# Print each filter
for f in filters:
filter_id = f.get('id', 'N/A')
name = f.get('name', 'N/A')[:39] # Truncate if too long
owner_name = f.get('owner', {}).get('displayName', 'N/A')[:29]
is_public = 'Yes' if is_public_filter(f) else 'No'
last_viewed = format_last_viewed(f.get('viewUrl')) # Note: lastViewed may not be available
print(f"{filter_id:<10} {name:<40} {owner_name:<30} {is_public:<8} {last_viewed:<20}")
print(f"\nTotal filters: {len(filters)}")
def print_filters_detailed(filters):
"""
Print detailed information for each filter.
Args:
filters: List of filter dictionaries
"""
if not filters:
print("No filters found.")
return
for i, f in enumerate(filters, 1):
print(f"\n{'='*80}")
print(f"Filter #{i}")
print(f"{'='*80}")
print(f"ID: {f.get('id', 'N/A')}")
print(f"Name: {f.get('name', 'N/A')}")
print(f"Description: {f.get('description', 'N/A')}")
print(f"Owner: {f.get('owner', {}).get('displayName', 'N/A')} ({f.get('owner', {}).get('emailAddress', 'N/A')})")
print(f"JQL: {f.get('jql', 'N/A')}")
print(f"Public: {'Yes' if is_public_filter(f) else 'No'}")
print(f"Favorite: {f.get('favourite', False)}")
print(f"View URL: {f.get('viewUrl', 'N/A')}")
print(f"Search URL: {f.get('searchUrl', 'N/A')}")
def export_to_json(filters, filename='jira_filters.json'):
"""
Export filters to JSON file.
Args:
filters: List of filter dictionaries
filename: Output filename
"""
try:
with open(filename, 'w', encoding='utf-8') as f:
json.dump(filters, f, indent=2, ensure_ascii=False)
print(f"\nFilters exported to {filename}")
except Exception as e:
print(f"Error exporting to JSON: {e}", file=sys.stderr)
def export_to_csv(filters, filename='jira_filters.csv'):
"""
Export filters to CSV file.
Args:
filters: List of filter dictionaries
filename: Output filename
"""
try:
import csv
with open(filename, 'w', newline='', encoding='utf-8') as f:
writer = csv.writer(f)
# Write header
writer.writerow(['ID', 'Name', 'Owner Name', 'Owner Email', 'JQL', 'Public', 'Favorite', 'Description', 'View URL'])
# Write data
for filter_data in filters:
writer.writerow([
filter_data.get('id', ''),
filter_data.get('name', ''),
filter_data.get('owner', {}).get('displayName', ''),
filter_data.get('owner', {}).get('emailAddress', ''),
filter_data.get('jql', ''),
'Yes' if is_public_filter(filter_data) else 'No',
filter_data.get('favourite', False),
filter_data.get('description', ''),
filter_data.get('viewUrl', '')
])
print(f"\nFilters exported to {filename}")
except Exception as e:
print(f"Error exporting to CSV: {e}", file=sys.stderr)
def main():
"""
Main function to execute the script.
"""
print("Jira Filters Listing Tool")
print("=" * 80)
# Validate credentials are configured
if JIRA_URL == "https://your-domain.atlassian.net" or \
JIRA_EMAIL == "your-email@example.com" or \
JIRA_API_TOKEN == "your-api-token-here":
print("\nERROR: Please update the configuration variables at the top of the script:")
print(" - JIRA_URL")
print(" - JIRA_EMAIL")
print(" - JIRA_API_TOKEN")
sys.exit(1)
# Create authentication
auth = HTTPBasicAuth(JIRA_EMAIL, JIRA_API_TOKEN)
# Fetch all filters
print("\nFetching filters...")
filters = get_all_filters(JIRA_URL, auth)
# Sort filters by name
filters.sort(key=lambda x: x.get('name', '').lower())
# Display options
print(f"\nFound {len(filters)} filters.")
print("\nDisplay options:")
print("1. Table view (summary)")
print("2. Detailed view")
print("3. Export to JSON")
print("4. Export to CSV")
print("5. All of the above")
choice = input("\nEnter your choice (1-5): ").strip()
if choice == '1' or choice == '5':
print_filters_table(filters)
if choice == '2' or choice == '5':
print_filters_detailed(filters)
if choice == '3' or choice == '5':
export_to_json(filters)
if choice == '4' or choice == '5':
export_to_csv(filters)
if choice not in ['1', '2', '3', '4', '5']:
print("Invalid choice. Showing table view by default.")
print_filters_table(filters)
if __name__ == "__main__":
main()
You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.