{"id":15010024,"url":"https://github.com/mtreinish/stestr","last_synced_at":"2025-11-17T03:43:04.685Z","repository":{"id":13285501,"uuid":"74060146","full_name":"mtreinish/stestr","owner":"mtreinish","description":"A parallel Python test runner built around subunit","archived":false,"fork":false,"pushed_at":"2025-04-28T12:54:03.000Z","size":3095,"stargazers_count":32,"open_issues_count":31,"forks_count":35,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-10-02T01:19:06.268Z","etag":null,"topics":["python","python-3-10","python-3-11","python-3-12","python-3-7","python-3-8","python-3-9","test-runner","testing-tools"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mtreinish.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2016-11-17T19:27:58.000Z","updated_at":"2025-04-21T18:52:48.000Z","dependencies_parsed_at":"2024-05-16T22:23:56.423Z","dependency_job_id":"e5c1cc41-39fe-49ce-96f2-05b0be3b9998","html_url":"https://github.com/mtreinish/stestr","commit_stats":{"total_commits":794,"total_committers":46,"mean_commits":17.26086956521739,"dds":0.6561712846347607,"last_synced_commit":"386276626f78b40aad132252971ee28fed968e4b"},"previous_names":[],"tags_count":27,"template":false,"template_full_name":null,"purl":"pkg:github/mtreinish/stestr","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mtreinish%2Fstestr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mtreinish%2Fstestr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mtreinish%2Fstestr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mtreinish%2Fstestr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mtreinish","download_url":"https://codeload.github.com/mtreinish/stestr/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mtreinish%2Fstestr/sbom","scorecard":{"id":666772,"data":{"date":"2025-08-11","repo":{"name":"github.com/mtreinish/stestr","commit":"10b977702e2ec5502a48e4fa4c280fcf2cd2577e"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.5,"checks":[{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/main.yml:1","Warn: no topLevel permission defined: .github/workflows/release.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Code-Review","score":4,"reason":"Found 4/10 approved changesets -- score normalized to 4","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/mtreinish/stestr/main.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:47: update your workflow using https://app.stepsecurity.io/secureworkflow/mtreinish/stestr/main.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:51: update your workflow using https://app.stepsecurity.io/secureworkflow/mtreinish/stestr/main.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:67: update your workflow using https://app.stepsecurity.io/secureworkflow/mtreinish/stestr/main.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:69: update your workflow using https://app.stepsecurity.io/secureworkflow/mtreinish/stestr/main.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:73: update your workflow using https://app.stepsecurity.io/secureworkflow/mtreinish/stestr/main.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:86: update your workflow using https://app.stepsecurity.io/secureworkflow/mtreinish/stestr/main.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:98: update your workflow using https://app.stepsecurity.io/secureworkflow/mtreinish/stestr/main.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:102: update your workflow using https://app.stepsecurity.io/secureworkflow/mtreinish/stestr/main.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:106: update your workflow using https://app.stepsecurity.io/secureworkflow/mtreinish/stestr/main.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:118: update your workflow using https://app.stepsecurity.io/secureworkflow/mtreinish/stestr/main.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/mtreinish/stestr/main.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/mtreinish/stestr/main.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/mtreinish/stestr/main.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/mtreinish/stestr/release.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/mtreinish/stestr/release.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/mtreinish/stestr/release.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/mtreinish/stestr/release.yml/main?enable=pin","Warn: pipCommand not pinned by hash: .github/workflows/main.yml:32","Warn: pipCommand not pinned by hash: .github/workflows/main.yml:38","Warn: pipCommand not pinned by hash: .github/workflows/main.yml:61","Warn: pipCommand not pinned by hash: .github/workflows/main.yml:83","Warn: pipCommand not pinned by hash: .github/workflows/main.yml:116","Warn: pipCommand not pinned by hash: .github/workflows/release.yml:21","Info:   0 out of  16 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   2 third-party GitHubAction dependencies pinned","Info:   0 out of   6 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Packaging","score":10,"reason":"packaging workflow detected","details":["Info: Project packages its releases by way of GitHub Actions.: .github/workflows/release.yml:7"],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Vulnerabilities","score":9,"reason":"1 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: PYSEC-2024-48 / GHSA-fj7x-q9j7-g6q6"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-21T18:19:21.913Z","repository_id":13285501,"created_at":"2025-08-21T18:19:21.913Z","updated_at":"2025-08-21T18:19:21.913Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":284818572,"owners_count":27068110,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-11-17T02:00:06.431Z","response_time":55,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["python","python-3-10","python-3-11","python-3-12","python-3-7","python-3-8","python-3-9","test-runner","testing-tools"],"created_at":"2024-09-24T19:29:33.811Z","updated_at":"2025-11-17T03:43:04.670Z","avatar_url":"https://github.com/mtreinish.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"======\nstestr\n======\n\n.. image:: https://github.com/mtreinish/stestr/actions/workflows/main.yml/badge.svg?branch=main\n    :target: https://github.com/mtreinish/stestr/actions/workflows/main.yml\n    :alt: CI Testing status\n\n.. image:: https://img.shields.io/codecov/c/gh/mtreinish/stestr?style=flat-square\n    :target: https://codecov.io/gh/mtreinish/stestr\n    :alt: Code coverage\n\n.. image:: https://img.shields.io/pypi/v/stestr.svg?style=flat-square\n    :target: https://pypi.python.org/pypi/stestr\n    :alt: Latest Version\n\n.. image:: https://img.shields.io/github/license/mtreinish/stestr.svg?style=popout-square\n    :target: https://opensource.org/licenses/Apache-2.0\n    :alt: License:\n\n* Read this in other languages: `English`_, `日本語`_\n* You can see the full rendered docs at: http://stestr.readthedocs.io/en/latest/\n* The code of the project is on Github: https://github.com/mtreinish/stestr\n\n.. _English: https://github.com/mtreinish/stestr/blob/main/README.rst\n.. _日本語: https://github.com/mtreinish/stestr/blob/main/README_ja.rst\n\n.. note:: stestr v2.x.x release series will be the last series that supports\n    Python 2. Support for Python 2.7 was dropped in stestr release 3.0.0.\n\nOverview\n--------\n\nstestr is parallel Python test runner designed to execute `unittest`_ test\nsuites using multiple processes to split up execution of a test suite. It also\nwill store a history of all test runs to help in debugging failures and\noptimizing the scheduler to improve speed. To accomplish this goal it uses the\n`subunit`_ protocol to facilitate streaming and storing results from multiple\nworkers.\n\n.. _unittest: https://docs.python.org/3/library/unittest.html\n.. _subunit: https://github.com/testing-cabal/subunit\n\nstestr originally started as a fork of the `testrepository`_ project. But,\ninstead of being an interface for any test runner that used subunit, like\ntestrepository, stestr concentrated on being a dedicated test runner for python\nprojects. While stestr was originally forked from testrepository it is not\nbackwards compatible with testrepository. At a high level the basic concepts of\noperation are shared between the two projects but the actual usage is not\nexactly the same.\n\n.. _testrepository: https://testrepository.readthedocs.org/en/latest\n\n\nInstalling stestr\n-----------------\n\nstestr is available via pypi, so all you need to do is run::\n\n  pip install -U stestr\n\nto get stestr on your system. If you need to use a development version of\nstestr you can clone the repo and install it locally with::\n\n  git clone https://github.com/mtreinish/stestr.git \u0026\u0026 pip install -e stestr\n\nwhich will install stestr in your python environment in editable mode for local\ndevelopment\n\nUsing stestr\n------------\n\nAfter you install stestr to use it to run tests is pretty straightforward. The\nfirst thing you'll want to do is create a ``.stestr.conf`` file for your\nproject. This file is used to tell stestr where to find tests and basic\ninformation about how tests are run. A basic minimal example of the\ncontents of this is::\n\n  [DEFAULT]\n  test_path=./project_source_dir/tests\n\nwhich just tells stestr the relative path for the directory to use for\ntest discovery. This is the same as ``--start-directory`` in the standard\n`unittest discovery`_.\n\n.. _unittest discovery: https://docs.python.org/3/library/unittest.html#test-discovery\n\nAlternatively, if you're using stestr with\n`tox \u003chttps://tox.readthedocs.io/en/latest/\u003e`__ you can integrate your stestr\nconfig in a ``stestr`` section in the tox.ini file, for example::\n\n  [stestr]\n  test_path=./project_source_dir/tests\n\nAfter stestr is configured you should be all set to start using stestr\nto run tests. To run tests just use::\n\n    stestr run\n\nit will first create a results repository at ``.stestr/`` in the current\nworking directory and then execute all the tests found by test discovery. If\nyou're just running a single test (or module) and want to avoid the overhead of\ndoing test discovery you can use the ``--no-discover``/``-n`` option to specify\nthat test.\n\nFor all the details on these commands and more thorough explanation of options\nsee the stestr manual: https://stestr.readthedocs.io/en/latest/MANUAL.html\n\nMigrating from testrepository\n-----------------------------\n\nIf you have a project that is already using testrepository stestr's source repo\ncontains a helper script for migrating your repo to use stestr. This script\njust creates a ``.stestr.conf`` file from a ``.testr.conf`` file.\n(assuming it uses a standard subunit.run test command format) To run\nthis from your project repo just call::\n\n    $STESTR_SOURCE_DIR/tools/testr_to_stestr.py\n\nand you'll have a ``.stestr.conf`` created.\n\nBuilding a manpage\n------------------\n\nThe stestr manual has been formatted so that it renders well as html and as a\nmanpage. The html output and is autogenerated and published to:\nhttps://stestr.readthedocs.io/en/latest/MANUAL.html but the manpage has to be\ngenerated by hand. To do this you have to manually run sphinx-build with the\nmanpage builder. This has been automated in a small script that should be run\nfrom the root of the stestr repository::\n\n  tools/build_manpage.sh\n\nwhich will generate the troff file in doc/build/man/stestr.1 which is ready to\nbe packaged and or put in your system's man pages.\n\nContributing\n------------\n\nTo browse the latest code, see: https://github.com/mtreinish/stestr\nTo clone the latest code, use: ``git clone https://github.com/mtreinish/stestr.git``\n\nGuidelines for contribution are documented at: http://stestr.readthedocs.io/en/latest/developer_guidelines.html\n\nUse `github pull requests`_ to submit patches. Before you submit a pull request\nensure that all the automated testing will pass by running ``tox`` locally.\nThis will run the test suite and also the automated style rule checks just as\nthey will in CI. If CI fails on your change it will not be able to merge.\n\n.. _github pull requests: https://help.github.com/articles/about-pull-requests/\n\nCommunity\n---------\n\nBesides Github interactions there is also a stestr IRC channel:\n\n#stestr on `OFTC \u003chttps://oftc.net/\u003e`__\n\nfeel free to join to ask questions, or just discuss stestr.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmtreinish%2Fstestr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmtreinish%2Fstestr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmtreinish%2Fstestr/lists"}