{"id":26376921,"url":"https://github.com/loftwah/auto-jira","last_synced_at":"2025-03-17T03:19:30.877Z","repository":{"id":279151540,"uuid":"937869981","full_name":"loftwah/auto-jira","owner":"loftwah","description":"A CLI that takes a requirements document and automatically creates suitable JIRA tickets for you.","archived":false,"fork":false,"pushed_at":"2025-02-24T09:26:43.000Z","size":74,"stargazers_count":10,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-16T01:47:37.397Z","etag":null,"topics":["automation","jira","openai","project-management","requirements"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/loftwah.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-02-24T03:28:12.000Z","updated_at":"2025-02-25T22:42:38.000Z","dependencies_parsed_at":"2025-02-24T04:27:58.428Z","dependency_job_id":"72531031-d4e3-4a96-b027-953633b79740","html_url":"https://github.com/loftwah/auto-jira","commit_stats":null,"previous_names":["loftwah/auto-jira"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loftwah%2Fauto-jira","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loftwah%2Fauto-jira/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loftwah%2Fauto-jira/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loftwah%2Fauto-jira/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/loftwah","download_url":"https://codeload.github.com/loftwah/auto-jira/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243965730,"owners_count":20375920,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automation","jira","openai","project-management","requirements"],"created_at":"2025-03-17T03:19:30.460Z","updated_at":"2025-03-17T03:19:30.869Z","avatar_url":"https://github.com/loftwah.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# AI-Powered Jira Ticket Generator\n\nThe AI-Powered Jira Ticket Generator is a CLI tool that leverages OpenAI to transform high-level project requirements into detailed Jira tickets. Whether your input is in HTML, Markdown, or plain text, the tool uses GPT-4 (or later) to generate tickets complete with metadata, risk assessments, and pull request details.\n\n## Key Features\n\n- **Input Parsing:** Supports HTML, Markdown, and plain text.\n- **Ticket Generation:** Produces comprehensive Jira tickets including:\n  - Title and description\n  - Dependencies\n  - Risk analysis\n  - Pull request details\n- **Modes:**\n  - **Interactive Mode:** Iteratively refine tickets with live feedback.\n  - **Non-Interactive Mode:** Generate tickets in a one-shot command.\n- **Customizable Integration:** Configure OpenAI API URL and API key as needed.\n- **Output Formats:** Defaults to Markdown; JSON output is also supported.\n\n## Getting Started\n\n### Prerequisites\n\n- Python 3.12 or later\n- [uv](https://github.com/astral-sh/uv) for virtual environment and dependency management\n- Python dependencies:\n  - openai\u003e=1.12.0,\u003c2.0.0\n  - mistune\u003e=3.0.0\n  - beautifulsoup4\u003e=4.12.0\n  - lxml\u003e=5.1.0\n  - python-dotenv\u003e=1.0.0\n\n### Setup Instructions\n\n1. **Create and activate a virtual environment:**\n   ```bash\n   uv venv\n   # On Linux/Mac:\n   source .venv/bin/activate\n   # On Windows:\n   .venv\\Scripts\\activate\n   ```\n2. **Install dependencies:**\n   ```bash\n   uv pip install -r requirements.txt\n   ```\n\n## Running the Application\n\n### Non-Interactive Mode (Automated Ticket Generation)\n\nFor a fast, one-shot ticket generation from a requirements file, run:\n\n```bash\nuv run app.py --file requirements.md --non-interactive\n```\n\nAdditional options:\n- `--model \u003cmodel-name\u003e`: Specify the AI model (default: 'gpt-4o')\n- `--api-url \u003curl\u003e`: Set a custom API URL (default: 'https://api.openai.com/v1/')\n- `--api-key \u003ckey\u003e`: Provide an API key\n- `--output-format \u003cformat\u003e`: Choose output format ('markdown' or 'json')\n\n**What to Expect:**\n\n- **Input:** The tool reads your `requirements.md` file containing the project requirements.\n- **Processing:** The content is sent to the GPT-4o (or later) API, which processes and generates detailed ticket information.\n- **Output:** Tickets are output in Markdown format (or JSON if specified) and include comprehensive details:\n  - **Title** and **Description** of the ticket\n  - **Dependencies** for further work\n  - **Risk Assessments** and potential issues\n  - **Pull Request (PR) Details** for implementation\n- **Automation:** The command executes without prompting for further interaction, perfect for automated workflows.\n\n### Interactive Mode (Iterative Refinement)\n\nTo manually refine the ticket creation process, simply run:\n\n```bash\nuv run app.py\n```\n\n- **Direct Input:** If no file is provided, you will be prompted to paste or type your requirements.\n- **Feedback Guided:** After initial ticket generation, you can review the output and provide feedback for refinements.\n- **Repeat as Needed:** Continue refining until you are completely satisfied with the tickets.\n\n## Docker Deployment\n\nFor containerized deployment, see [docker.md](docker.md) which provides detailed instructions on building the Docker image, running the container, and managing environment variables securely.\n\n## Contributing\n\nContributions are welcome! Please reference the guidelines in [.cursorrules](.cursorrules) for code style, testing, documentation, and security guidelines before contributing.\n\n## License\n\nThis project is licensed under the MIT License. Please see the [LICENSE](LICENSE) file for further details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Floftwah%2Fauto-jira","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Floftwah%2Fauto-jira","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Floftwah%2Fauto-jira/lists"}