Skip to main content

pytest-upload-report is a plugin for pytest that upload your test report for test results.

Project description

PyPI version Python versions See Build Status on Travis CI See Build Status on AppVeyor

English | 简体中文

pytest-upload-report is a plugin for pytest that upload your test report for test results.


  • Upload report for allure-pytest.

  • Upload report for pytest-html.


  • Python >= 3.7

  • pytest

  • requests

  • allure-pytest, if you use allure report.

  • pytest-html, if you use html report.


You can install “pytest-upload-report” via pip from PyPI:

$ pip install pytest-upload-report


A simple example

Directly upload report files to server by upload_url.

On the command line, add upload_url option when run pytest command:

pytest --alluredir=/tmp/my_allure_results --upload_url=

A complete example

Now let us demonstrate how to use in a vaguely real world scenario.

First, you must have a upload api on server, an example for fastapi:

from fastapi import APIRouter, UploadFile, File, Header

router = APIRouter(prefix='/api/script', tags=['script'])"/reports/upload")
async def report_upload_by_api(
    project_id: int,
    timestamp: int,
    username: str,
    sign: str = Header(...),
    files: List[UploadFile] = File(...),
    return 'ok'

Second, edit your file, add pytest_send_upload_request hook:

import pytest

def pytest_send_upload_request(upload_url, files, config):
    from pytest_upload_report.upload_client import SignUploadClient
    client = SignUploadClient(upload_url, files)
    return True

The other hooks will be blocked from executing, when then hook return True. If you want to upload multiple places, don’t write any return.

Third, edit pytest.init on you test project root dir:

addopts = --alluredir=/tmp/my_allure_results --upload_url= --upload_project_id=4 --upload_username=admin --upload_secret=8FB6CFB4C8CF11EBB523DCA9048E18C3

Finally, run pytest command on you test project root dir:

$ pytest

Also, you can view source code in the example directory.

How to Customize

If the above does not meet your needs, you can customize request client.


Contributions are very welcome. Tests can be run with tox, please ensure the coverage at least stays the same before you submit a pull request.


Distributed under the terms of the MIT license, “pytest-upload-report” is free and open source software


If you encounter any problems, please file an issue along with a detailed description.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytest-upload-report-0.1.0.tar.gz (6.7 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page