{"id":38956518,"url":"https://github.com/tolstislon/testrail-api","last_synced_at":"2026-01-17T16:17:29.553Z","repository":{"id":33525324,"uuid":"159044891","full_name":"tolstislon/testrail-api","owner":"tolstislon","description":"Python wrapper of the TestRail API","archived":false,"fork":false,"pushed_at":"2025-12-30T09:13:15.000Z","size":273,"stargazers_count":35,"open_issues_count":5,"forks_count":20,"subscribers_count":2,"default_branch":"master","last_synced_at":"2026-01-02T18:48:34.504Z","etag":null,"topics":["python","python-wrapper","testrail","testrail-api"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tolstislon.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2018-11-25T15:15:43.000Z","updated_at":"2025-12-30T09:08:41.000Z","dependencies_parsed_at":"2023-09-24T16:47:19.334Z","dependency_job_id":"f54cdc37-1f8c-4a91-9967-965deca5606c","html_url":"https://github.com/tolstislon/testrail-api","commit_stats":{"total_commits":101,"total_committers":16,"mean_commits":6.3125,"dds":0.5544554455445545,"last_synced_commit":"6794a118056f7b72ba6ddb217e95de119a50d334"},"previous_names":[],"tags_count":46,"template":false,"template_full_name":null,"purl":"pkg:github/tolstislon/testrail-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tolstislon%2Ftestrail-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tolstislon%2Ftestrail-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tolstislon%2Ftestrail-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tolstislon%2Ftestrail-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tolstislon","download_url":"https://codeload.github.com/tolstislon/testrail-api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tolstislon%2Ftestrail-api/sbom","scorecard":{"id":891719,"data":{"date":"2025-08-11","repo":{"name":"github.com/tolstislon/testrail-api","commit":"66b61271086bd30b76d508b9a639277cdbc6427e"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.5,"checks":[{"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":"Code-Review","score":3,"reason":"Found 11/30 approved changesets -- score normalized to 3","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":"Maintained","score":0,"reason":"1 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":"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":1,"reason":"dependency not pinned by hash detected -- score normalized to 1","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python-package.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/tolstislon/testrail-api/python-package.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python-package.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/tolstislon/testrail-api/python-package.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python-publish.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/tolstislon/testrail-api/python-publish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python-publish.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/tolstislon/testrail-api/python-publish.yml/master?enable=pin","Warn: pipCommand not pinned by hash: .github/workflows/python-package.yml:25","Warn: pipCommand not pinned by hash: .github/workflows/python-package.yml:26","Warn: pipCommand not pinned by hash: .github/workflows/python-package.yml:27","Warn: pipCommand not pinned by hash: .github/workflows/python-publish.yml:31","Warn: pipCommand not pinned by hash: .github/workflows/python-publish.yml:32","Info:   0 out of   4 GitHub-owned GitHubAction dependencies pinned","Info:   1 out of   1 third-party GitHubAction dependencies pinned","Info:   0 out of   5 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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/python-package.yml:1","Info: topLevel 'contents' permission set to 'read': .github/workflows/python-publish.yml:16","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":"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":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"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":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: 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":"Packaging","score":10,"reason":"packaging workflow detected","details":["Info: Project packages its releases by way of GitHub Actions.: .github/workflows/python-publish.yml:19"],"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":"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":"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":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 27 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-24T12:06:01.855Z","repository_id":33525324,"created_at":"2025-08-24T12:06:01.855Z","updated_at":"2025-08-24T12:06:01.855Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28511854,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-17T13:38:16.342Z","status":"ssl_error","status_checked_at":"2026-01-17T13:37:44.060Z","response_time":85,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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-wrapper","testrail","testrail-api"],"created_at":"2026-01-17T16:17:29.476Z","updated_at":"2026-01-17T16:17:29.536Z","avatar_url":"https://github.com/tolstislon.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Testrail Api\n\n[![PyPI](https://img.shields.io/pypi/v/testrail-api?color=%2301a001\u0026label=pypi\u0026logo=version)](https://pypi.org/project/testrail-api/)\n[![Downloads](https://pepy.tech/badge/testrail-api)](https://pepy.tech/project/testrail-api)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/testrail-api.svg)](https://pypi.org/project/testrail-api/)\n[![PyPI - Implementation](https://img.shields.io/pypi/implementation/testrail-api)](https://pypi.org/project/testrail-api/)\n[![Build Pypi](https://github.com/tolstislon/testrail-api/actions/workflows/python-publish.yml/badge.svg)](https://github.com/tolstislon/testrail-api)\n\nThis is a Python wrapper of the TestRail API according\nto [the official documentation](https://www.gurock.com/testrail/docs/api)\n\n\nInstall\n----\nInstall using pip with\n\n```bash\npip install testrail-api\n```\n\n##### Support environment variables\n\n```dotenv\nTESTRAIL_URL=https://example.testrail.com/\nTESTRAIL_EMAIL=example@mail.com\nTESTRAIL_PASSWORD=password\n```\n\nExample\n----\n\n```python\nfrom datetime import datetime\n\nfrom testrail_api import TestRailAPI\n\napi = TestRailAPI(\"https://example.testrail.com/\", \"example@mail.com\", \"password\")\n\n# if use environment variables\n# api = TestRailAPI()\n\n\nnew_milestone = api.milestones.add_milestone(\n    project_id=1,\n    name=\"New milestone\",\n    start_on=datetime.now()\n)\n\nmy_test_run = api.runs.add_run(\n    project_id=1,\n    suite_id=2,\n    name=\"My test run\",\n    include_all=True,\n    milestone_id=new_milestone[\"id\"]\n)\n\nresult = api.results.add_result_for_case(\n    run_id=my_test_run[\"id\"],\n    case_id=5,\n    status_id=1,\n    comment=\"Pass\",\n    version=\"1\"\n)\nattach = \"screenshots/attach.jpg\"\napi.attachments.add_attachment_to_result(result[\"id\"], attach)\n\napi.runs.close_run(my_test_run[\"id\"])\napi.milestones.update_milestone(new_milestone[\"id\"], is_completed=True)\n```\n\n#### Custom response handler\n\n```python\nfrom datetime import datetime\nimport simplejson\n\nfrom testrail_api import TestRailAPI\n\n\ndef my_handler(response):\n    if response.ok:\n        return simplejson.loads(response.text)\n    return 'Error'\n\n\napi = TestRailAPI(\"https://example.testrail.com/\", \"example@mail.com\", \"password\", response_handler=my_handler)\nnew_milestone = api.milestones.add_milestone(\n    project_id=1,\n    name=\"New milestone\",\n    start_on=datetime.now()\n)\n\n```\n\nContributing\n----\nContributions are very welcome.\n\n###### Getting started\n\n* python 3.11\n* pipenv 2022.12.19+\n\n1. Clone the repository\n    ```bash\n    git clone https://github.com/tolstislon/testrail-api.git\n    cd testrail-api\n   ```\n2. Install dev dependencies\n    ```bash\n    pipenv install --dev\n    pipenv shell\n   ```\n3. Run the black\n    ```bash\n    pipenv run black\n   ```\n4. Run the flake8\n    ```bash\n    pipenv run flake8\n   ```\n5. Run the tests\n    ```bash\n    pipenv run tests\n   ```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftolstislon%2Ftestrail-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftolstislon%2Ftestrail-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftolstislon%2Ftestrail-api/lists"}