Setup · Updated May 15, 2025

Step 1 - Installation

Follow these steps to get the project set up locally

1. Clone the Repo

   git clone https://github.com/tomeksdev/Emails-To-Issue.git
   cd Emails-To-Issue

2. Install Python (if not installed)

Make sure you’re running Python 3.8+.

Debian / Ubuntu

   sudo apt update
   sudo apt install -y python3 python3-pip

RHEL / CentOS / Rocky / AlmaLinux

   sudo dnf install -y python3 python3-pip

Arch Linux

   sudo pacman -S python python-pip
   python3 -m venv venv
   source venv/bin/activate  # macOS/Linux
   venv\Scripts\activate     # Windows

4. Install Dependencies

   pip install -r requirements.txt

Dependencies:

  • requests
  • python-dotenv
  • imaplib
  • email
  • re
  • talon (for signature extraction, optional)
  • logging

5. Configure Environment Variables

Typically you will need:

  • GitHub personal access token
  • Mailbox credentials (IMAP or API)
  • GitHub repository to create issues in

These go into a .env file or environment variables based on the script’s instructions.

   IMAP_SERVER=your.imap.server.com
   EMAIL_ACCOUNT=your-email@example.com
   EMAIL_PASSWORD=your-email-password
   GITHUB_REPO=your-username/your-repository
   GITHUB_TOKEN=your-github-personal-access-token

6. Save and verify the config file

Double-check that your keys, passwords, and repo names are correct.