TheReportStack CLI

A powerful CLI and Python package to seamlessly upload your automated test execution reports to the TheReportStack Dashboard.

⚡ Features

• Upload Instantly: Upload PyTest, Cucumber, and Newman JSON reports directly to your TheReportStack Dashboard project.
• Smart Tags: Supports parsing complex tag expressions (e.g. ["@smoke and @wallet"]).
• Flexible Authentication: Authenticate via project tokens, Environment Variables, or email & password.
• Zero Coding Required: Configure once with a simple json file and trigger from anywhere in your CI/CD pipelines.

📦 Installation

Install the package via pip:

pip install thereportstack

🚀 Quick Start

1. Initialize Configuration

Navigate to your project directory and run the initialization command. This creates the configuration structure.

thereportstack init

This generates a thereportstack/config.json file in your current directory with default values.

You can also configure the project directly from the command line by passing arguments. This will instantly populate or update the config.json file:

thereportstack init --projectId YOUR_PROJECT_ID --tags "smoke" "regression" --typeOfReport pytest

2. Configure Your Project

Edit the generated thereportstack/config.json with your project's specifics.

{
  "typeOfReport": "pytest",
  "projectId": "YOUR_PROJECT_ID",
  "file": "path/to/report.json",
  "testEnv": "QA",
  "testType": "WEB",
  "tags": ["smoke", "regression"],
  "browser": "chrome",
  "browserVersion": "latest",
  "iterationId": "Batch1",
  "baseUrl": "https://app.thereportstack.com/api/v1/public"
}

Don't want to expose your token in code? Remove the "token" field from the config and export it as an environment variable in your CI/CD tool:

export DASHBOARD_TOKEN="YOUR_API_TOKEN"

3. Upload Report

Once your config is set and your testing framework has generated the JSON report, run:

thereportstack start

That's it! 🚀 Your test execution report is now beautifully cataloged on the TheReportStack Dashboard.

🔧 Configuration Reference

🔑 Authentication Methods

TheReportStack gives you several options for secure authentication:

1. Config Token: Place "token": "YOUR_TOKEN" directly in the config.json.
2. Environment Variable: Export DASHBOARD_TOKEN on your machine or CI/CD runner.
3. Email & Password: You can provide "email" and "password" fields in config.json and the CLI will automatically securely negotiate an authentication token. (Token/Environment Token takes precedent).

✨ Tag Parsing Support

To make QA tagging flexible, thereportstack CLI automatically normalizes boolean-style or nested BDD tags coming from your project definitions before sending them to the dashboard:

• ["@smoke and @wallet"] ➡️ ["smoke", "wallet"]
• ["smoke, regression"] ➡️ ["smoke", "regression"]
• ["(checkout)"] ➡️ ["checkout"]

🤝 Support

If you encounter any issues integrating this into your Python, Node, Java, or Ruby pipelines, please reach out directly to the TheReportStack maintainers.