{"id":19119010,"url":"https://github.com/journy-io/python-sdk","last_synced_at":"2026-02-07T03:31:03.199Z","repository":{"id":47473902,"uuid":"338286518","full_name":"journy-io/python-sdk","owner":"journy-io","description":"🐍 The official Python SDK that you can use to easily interact with our API","archived":false,"fork":false,"pushed_at":"2023-10-13T18:08:02.000Z","size":332,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-09-04T06:23:36.556Z","etag":null,"topics":["api","python","python3","sdk","sdk-python"],"latest_commit_sha":null,"homepage":"https://developers.journy.io/","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/journy-io.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}},"created_at":"2021-02-12T10:27:18.000Z","updated_at":"2021-12-14T16:07:23.000Z","dependencies_parsed_at":"2025-05-05T14:45:30.050Z","dependency_job_id":"fbce87ed-31af-41fe-97ac-9d7a6d0eb449","html_url":"https://github.com/journy-io/python-sdk","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/journy-io/python-sdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/journy-io%2Fpython-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/journy-io%2Fpython-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/journy-io%2Fpython-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/journy-io%2Fpython-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/journy-io","download_url":"https://codeload.github.com/journy-io/python-sdk/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/journy-io%2Fpython-sdk/sbom","scorecard":{"id":534922,"data":{"date":"2025-08-11","repo":{"name":"github.com/journy-io/python-sdk","commit":"584d8f5b032e76873a1c960245df55e288f662d7"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.6,"checks":[{"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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/check-code-style.yml:1","Warn: no topLevel permission defined: .github/workflows/lint-and-test.yml:1","Warn: no topLevel permission defined: .github/workflows/python-publish.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":"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":"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":"Code-Review","score":4,"reason":"Found 7/16 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":"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":"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/check-code-style.yml:8: update your workflow using https://app.stepsecurity.io/secureworkflow/journy-io/python-sdk/check-code-style.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/check-code-style.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/journy-io/python-sdk/check-code-style.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint-and-test.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/journy-io/python-sdk/lint-and-test.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint-and-test.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/journy-io/python-sdk/lint-and-test.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python-publish.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/journy-io/python-sdk/python-publish.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python-publish.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/journy-io/python-sdk/python-publish.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/python-publish.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/journy-io/python-sdk/python-publish.yml/main?enable=pin","Warn: pipCommand not pinned by hash: .github/workflows/lint-and-test.yml:18","Warn: pipCommand not pinned by hash: .github/workflows/lint-and-test.yml:19","Warn: pipCommand not pinned by hash: .github/workflows/lint-and-test.yml:20","Warn: pipCommand not pinned by hash: .github/workflows/python-publish.yml:18","Warn: pipCommand not pinned by hash: .github/workflows/python-publish.yml:19","Info:   0 out of   5 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   2 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":"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":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"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":"Security-Policy","score":10,"reason":"security policy file detected","details":["Info: security policy file detected: github.com/journy-io/.github/SECURITY.md:1","Info: Found linked content: github.com/journy-io/.github/SECURITY.md:1","Info: Found disclosure, vulnerability, and/or timelines in security policy: github.com/journy-io/.github/SECURITY.md:1","Info: Found text in security policy: github.com/journy-io/.github/SECURITY.md:1"],"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":7,"reason":"3 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-9hjg-9r4m-mvj7","Warn: Project is vulnerable to: GHSA-9wx4-h78v-vm56","Warn: Project is vulnerable to: PYSEC-2023-74 / GHSA-j8r2-6x86-q33q"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"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 21 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-20T06:41:31.494Z","repository_id":47473902,"created_at":"2025-08-20T06:41:31.494Z","updated_at":"2025-08-20T06:41:31.494Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29185344,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-07T00:44:15.062Z","status":"online","status_checked_at":"2026-02-07T02:00:07.217Z","response_time":63,"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":["api","python","python3","sdk","sdk-python"],"created_at":"2024-11-09T05:08:18.874Z","updated_at":"2026-02-07T03:31:03.184Z","avatar_url":"https://github.com/journy-io.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![journy.io](https://raw.githubusercontent.com/journy-io/python-sdk/main/banner.png?token=AIYSKXPKLRTOT3S4HQDXE2DAGPNL4)](https://journy.io/?utm_source=github\u0026utm_content=readme-python-sdk)\n\n# journy.io Python SDK\n\n[![pypi](https://img.shields.io/pypi/v/journyio-sdk?color=%234d84f5\u0026style=flat-square)](https://pypi.org/project/journyio-sdk) ![pypi downloads](https://img.shields.io/pypi/dm/journyio-sdk?color=%234d84f5\u0026style=flat-square) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n\nThis is the official Python SDK for [journy.io](https://journy.io?utm_source=github\u0026utm_content=readme-python-sdk).\n\n## 💾 Installation\n\nYou can use the python package manager (`pip`) to install the SDK:\n\n```bash\npip install journyio-sdk\n```\n\n## 🔌 Getting started\n\n### Import\n\nTo start, first import the client.\n\n```python\nfrom journyio.client import Client, Config\n```\n\n### Configuration\n\nTo be able to use the journy.io SDK you need to generate an API key. If you don't have one you can create one\nin [journy.io](https://system.journy.io?utm_source=github\u0026utm_content=readme-python-sdk).\n\nIf you don't have an account yet, you can create one\nin [journy.io](https://system.journy.io/register?utm_source=github\u0026utm_content=readme-python-sdk)\nor [request a demo first](https://www.journy.io/book-demo?utm_source=github\u0026utm_content=readme-python-sdk).\n\nGo to your settings, under the _Connections_-tab, to create and edit API keys. Make sure to give the correct permissions\nto the API Key.\n\n```python\nfrom journyio.httpclient import HttpClientRequests\n\nconfig = Config(\"api-key-secret\")\nhttp_client = HttpClientRequests()  # If wanted, an own implementation of the HttpClient interface can be created\nclient = Client(http_client, config)\n```\n\n### Methods\n\n#### Get API key details\n\n```python\nfrom journyio.results import Success\n\nresult = client.get_api_key_details()\nif isinstance(result, Success):\n    print(result.request_id)  # str\n    print(result.calls_remaining)  # int\n    print(result.data)  # ApiKeyDetails\n    print(result.permissions)  # list of strings denoting the permissions\n```\n\n### Handling errors\n\nEvery call will return a `Success` or `Failure` object. `Success` objects refer to the call having succeeded (and\noptionally containing data). A `Failure` object refers to the API returning an error. This can be any `APIError` (too\nmany requests, not found...). Our SDK only throws `JournyExceptions`, no other exceptions should be\ncalled. `JournyExceptions` are provided with useful messages, which state where the error was made.\n\n```python\nfrom journyio.utils import JournyException\n\ntry:\n    result = client.get_tracking_snippet(\"www.journy.io\")\n    if isinstance(result, Success):\n        print(result.request_id)  # str\n        print(result.calls_remaining)  # int\n        print(result.data)  # TrackingSnippetResonse\n    else:\n        print(result.request_id)  # str\n        print(result.calls_remaining)  # int\n        print(result.error)  # APIError\nexcept JournyException as e:\n    print(e.msg)  # str with error message\n```\n\nThe request ID can be useful when viewing API logs\nin [journy.io](https://system.journy.io?utm_source=github\u0026utm_content=readme-python-sdk).\n\n## 📬 API Docs\n\n[API reference](https://developers.journy.io)\n\n## 💯 Tests\n\nTo run the tests:\n\n```bash\ncd tests\npip install -r requirements.txt\npip install -U pytest\npython scripts/createversion.py 0.0.0\npytest\n```\n\n## ❓ Help\n\nWe welcome your feedback, ideas and suggestions. We really want to make your life easier, so if we’re falling short or\nshould be doing something different, we want to hear about it.\n\nPlease create an issue or contact us via the chat on our website.\n\n## 🔒 Security\n\nIf you discover any security related issues, please email security at journy io instead of using the issue tracker.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjourny-io%2Fpython-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjourny-io%2Fpython-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjourny-io%2Fpython-sdk/lists"}