Skip to content

Trello Reporting Tool

A utility to create a draft Markdown file for reporting out on sprints. The tool pulls lists from a Trello board, asks the user to select which lists they want to use, then pulls the cards from those lists. It then creates a template Markdown file, as well as a csv of cards in matching lists and a Markdown file with some basic data analysis on the cards. After writing the public-facing report, the user can pull that out of the file to send off.

Setup

  1. Environment: Create a .env file based on .env.example.
  2. Installation: Run pip install -r requirements.txt.
  3. Configuration: Ensure TRELLO_BOARD_ID is set to the right board.

Workflow

  1. Run python main.py.
  2. Select the lists you wish to review.
  3. Find the generated files in their specific folders
  4. /reports for the template file
  5. /csv for the card csv file
  6. /data for the data analysis file
  7. Use the resources to draft a sprint summary.

File Structure

  • main.py: Core logic and API integration.
  • /reports/: Local storage for generated template Markdown files (Git ignored).
  • /csv/: Local storage for generated csv files (Git ignored).
  • /data/: Local storage for generated data analysis files (Git ignored).
  • .env: API credentials (Git ignored).
  • .env.example: A file with required environment variable names to be filled in.
  • requirements.txt: Info for python requirements to be installed.