Metadata-Version: 2.4
Name: tirajira
Version: 1.1.4
Summary: TiraJira - tool for automating mass task creation in Jira with support for JSON, YAML, CSV, Excel and XML formats
License-Expression: Apache-2.0
License-File: LICENSE
Keywords: jira,automation,task-creation,json,yaml,csv,excel,xml
Author: Artem Vasilev
Author-email: artempunkrocker@gmail.com
Requires-Python: >=3.10
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: PyYAML (>=6.0.3,<7.0.0)
Requires-Dist: jira (>=3.10.5,<4.0.0)
Requires-Dist: openpyxl (>=3.1.5,<4.0.0)
Requires-Dist: python-dotenv (>=1.2.2,<2.0.0)
Requires-Dist: tqdm (>=4.67.3,<5.0.0)
Project-URL: Documentation, https://github.com/artempunkrocker/tirajira
Project-URL: Homepage, https://github.com/artempunkrocker/tirajira
Project-URL: Repository, https://github.com/artempunkrocker/tirajira
Description-Content-Type: text/markdown

# TiraJira - Jira Task Automation

[![PyPI Version](https://badge.fury.io/py/tirajira.svg)](https://badge.fury.io/py/tirajira)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

**Tired of manually creating dozens or hundreds of tasks in Jira?** TiraJira is your solution!

TiraJira is a powerful command-line utility for automating mass task creation in Jira. Just prepare tasks in a file (JSON, YAML, CSV, Excel or XML), and TiraJira will do the rest - create all your tasks in minutes instead of hours of manual work.

## Key Features

- 🚀 **Mass Task Creation** - create dozens and hundreds of tasks in one operation
- 📁 **Support for Different Formats** - use familiar formats JSON, YAML, CSV, Excel or XML
- 🔗 **Automatic Epic Linking** - link tasks to epics without additional actions
- 🔗 **Creating Links Between Tasks** - automatically create links between new and existing tasks
- ⚡ **Batch Processing** - optimized task submission for maximum performance
- 🛠️ **Full Custom Field Support** - use all your Jira fields, including custom ones
- 📊 **Detailed Logging** - track the task creation process in real time
- 🛑 **Error Stop Mode** - stop processing when errors occur (--stop-on-error)
- 📋 **Report Generation** - get machine-readable reports in JSON, CSV, Excel, YAML, XML formats
- 🔁 **Execution Resumption** - continue from where you left off when errors occur
- 🔒 **Protection Against Directory Traversal Attacks** - preventing access to files outside the working directory

## Quick Start

1. Install TiraJira:
   ```bash
   pip3 install tirajira
   ```

2. Prepare a task file in JSON format:
   ```json
   [
     {
       "project": {"key": "PROJ"},
       "summary": "First task",
       "description": "Description of the first task",
       "issuetype": {"name": "Task"}
     }
   ]
   ```

3. Create tasks in Jira:
   ```bash
   tirajira import tasks.json
   ```

Done! Your tasks are created in Jira.

## System Requirements

- Python 3.10 or higher
- Access to Jira Server
- API token for Jira access

## Installation

For regular users (recommended):
```bash
pip3 install tirajira
```

For developers:
```bash
git clone https://github.com/your-login/tirajira.git
cd tirajira
poetry install
```

[More about installation](docs/installation.md)

## Jira Connection Setup

TiraJira supports two authentication modes:
- **Jira Cloud** - Basic Auth (email + API token)
- **Jira Server/Data Center** - Personal Access Token

[More about connection setup](docs/configuration.md)

## Preparing a Task File

Supported formats: JSON, YAML, CSV, Excel, XML

Minimal example (JSON):
```json
[
  {
    "project": {"key": "PROJ"},
    "summary": "My first task",
    "issuetype": {"name": "Task"}
  }
]
```

[More about file formats](docs/file_formats.md)

## Commands

- `import` - Create tasks from file
- `resume` - Resume execution from report
- `extract-failed` - Extract failed tasks from report

[More about commands](docs/commands.md)

## Detailed Documentation

- [🔧 Installation and Setup](docs/installation.md)
- [🔐 Jira Connection Setup](docs/configuration.md)
- [📝 Preparing Task Files](docs/file_formats.md)
- [🧰 Commands and Options](docs/commands.md)
- [💡 Practical Examples](docs/examples.md)
- [📋 Supported Task Fields](docs/fields.md)
- [🛑 Request Rate Limiting Management](docs/rate_limiting.md)
- [❓ Solving Common Problems](docs/troubleshooting.md)
- [🤔 Frequently Asked Questions](docs/faq.md)
- [📊 Report Format](docs/reports.md)
- [👥 Contributing](docs/contributing.md)
- [🆘 Support](docs/support.md)

## License

Apache License 2.0 - see [LICENSE](LICENSE) file for details.
