{"id":34637823,"url":"https://github.com/lumapps/lumapps-sdk","last_synced_at":"2025-12-24T17:12:07.077Z","repository":{"id":33794845,"uuid":"150589806","full_name":"lumapps/lumapps-sdk","owner":"lumapps","description":"SDK to facilitate using LumApps API","archived":false,"fork":false,"pushed_at":"2025-12-03T11:06:38.000Z","size":11075,"stargazers_count":6,"open_issues_count":6,"forks_count":10,"subscribers_count":28,"default_branch":"master","last_synced_at":"2025-12-05T11:23:46.184Z","etag":null,"topics":["integration","lumapps","python","sdk-python"],"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/lumapps.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-09-27T13:17:42.000Z","updated_at":"2025-12-03T11:06:42.000Z","dependencies_parsed_at":"2023-01-15T02:36:41.101Z","dependency_job_id":"1b832108-8e76-4ed2-b3f9-add35178d398","html_url":"https://github.com/lumapps/lumapps-sdk","commit_stats":{"total_commits":516,"total_committers":18,"mean_commits":"28.666666666666668","dds":0.6201550387596899,"last_synced_commit":"b773a6efa98e06ce50c5e90a403d0bfa1d5fe53a"},"previous_names":[],"tags_count":45,"template":false,"template_full_name":null,"purl":"pkg:github/lumapps/lumapps-sdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lumapps%2Flumapps-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lumapps%2Flumapps-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lumapps%2Flumapps-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lumapps%2Flumapps-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lumapps","download_url":"https://codeload.github.com/lumapps/lumapps-sdk/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lumapps%2Flumapps-sdk/sbom","scorecard":{"id":605059,"data":{"date":"2025-08-11","repo":{"name":"github.com/lumapps/lumapps-sdk","commit":"88db5594cedfe4d3786fcebf60f2bff76fa9313a"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":5.4,"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":"Code-Review","score":10,"reason":"all changesets reviewed","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":"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":"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/ci.yml:1","Warn: no topLevel permission defined: .github/workflows/commit-message-validator.yml:1","Warn: no topLevel permission defined: .github/workflows/github-actions-validator.yml:1","Warn: no topLevel permission defined: .github/workflows/pypi-publish.yml:1","Warn: no topLevel permission defined: .github/workflows/pypi.yml:1","Warn: no topLevel permission defined: .github/workflows/release-note.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":"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":"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":5,"reason":"dependency not pinned by hash detected -- score normalized to 5","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/lumapps/lumapps-sdk/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/lumapps/lumapps-sdk/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/lumapps/lumapps-sdk/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:54: update your workflow using https://app.stepsecurity.io/secureworkflow/lumapps/lumapps-sdk/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:57: update your workflow using https://app.stepsecurity.io/secureworkflow/lumapps/lumapps-sdk/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:67: update your workflow using https://app.stepsecurity.io/secureworkflow/lumapps/lumapps-sdk/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/commit-message-validator.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/lumapps/lumapps-sdk/commit-message-validator.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/commit-message-validator.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/lumapps/lumapps-sdk/commit-message-validator.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/github-actions-validator.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/lumapps/lumapps-sdk/github-actions-validator.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/github-actions-validator.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/lumapps/lumapps-sdk/github-actions-validator.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pypi-publish.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/lumapps/lumapps-sdk/pypi-publish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pypi-publish.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/lumapps/lumapps-sdk/pypi-publish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pypi-publish.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/lumapps/lumapps-sdk/pypi-publish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pypi.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/lumapps/lumapps-sdk/pypi.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pypi.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/lumapps/lumapps-sdk/pypi.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pypi.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/lumapps/lumapps-sdk/pypi.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-note.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/lumapps/lumapps-sdk/release-note.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-note.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/lumapps/lumapps-sdk/release-note.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-note.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/lumapps/lumapps-sdk/release-note.yml/master?enable=pin","Info:   0 out of  16 GitHub-owned GitHubAction dependencies pinned","Info:   7 out of  10 third-party GitHubAction 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":"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.md:0","Info: FSF or OSI recognized license: MIT License: LICENSE.md:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"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":8,"reason":"branch protection is not maximal on development and all release branches","details":["Info: 'allow deletion' disabled on branch 'master'","Info: 'force pushes' disabled on branch 'master'","Warn: required approving review count is 1 on branch 'master'","Info: codeowner review is required on branch 'master'","Info: status check found to merge onto on branch 'master'","Info: PRs are required in order to make changes on branch 'master'"],"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 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-21T01:23:28.549Z","repository_id":33794845,"created_at":"2025-08-21T01:23:28.549Z","updated_at":"2025-08-21T01:23:28.549Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28005412,"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-12-24T02:00:07.193Z","response_time":83,"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":["integration","lumapps","python","sdk-python"],"created_at":"2025-12-24T17:08:27.230Z","updated_at":"2025-12-24T17:12:07.072Z","avatar_url":"https://github.com/lumapps.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Lumapps SDK\n\n\u003cp style=\"text-align:center\"\u003e\n    \u003ca href=\"https://github.com/lumapps/lumapps-sdk/actions?query=workflow%3ACI\"\u003e\u003cimg alt=\"Action Status\" src=\"https://github.com/lumapps/lumapps-sdk/workflows/CI/badge.svg\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://pypi.org/project/lumapps-sdk/\"\u003e\u003cimg alt=\"Pypi\" src=\"https://img.shields.io/pypi/v/lumapps-sdk\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://codecov.io/gh/lumapps/lumapps-sdk/branch/master\"\u003e\u003cimg alt=\"Coverage\" src=\"https://codecov.io/gh/lumapps/lumapps-sdk/branch/master/graph/badge.svg\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/ambv/black\"\u003e\u003cimg alt=\"Black\" src=\"https://img.shields.io/badge/code%20style-black-000000.svg\"\u003e\u003c/a\u003e\n    \u003ca href=\"#\"\u003e\u003cimg alt=\"Black\" src=\"https://img.shields.io/badge/python-3.8%7C3.9-blue\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\nLumApps SDK is a set of tools to manipulate the [LumApps API](https://api.lumapps.com/)\n\nThis includes:\n\n- A client that support all the routes of the API (located in folder lumapps)\n- A set of helper classes to easily manipulate LumApps elements as Python Objects and classes (folder lumapps/helpers)\n\n\n## Installation\n\n```bash\npip install lumapps-sdk\n```\n\n## Requirements\n\nPython \u003e= 3.8\n\n## Getting started\n\n1. Set up your OAuth application\n\n    Before anything else, you need to set up an OAuth application by following the steps in the [LumApps Developer Portal](https://developer.lumapps.com/documentation/oauth.html).\n\n2. Authenticate\n\n    Once your application set up, get a hand on its client ID and secret, then you can write the following\n    to get an access token for a particular user.\n    ```python\n    from lumapps.api import BaseClient\n\n    base_client = BaseClient(\n        api_info={\"base_url\": \"https://your-cell.api.lumapps.com\"}, # e.g. \"https://go-cell-001.api.lumapps.com\"\n        auth_info={\n            \"client_id\": \"your-client-id\",\n            \"client_secret\": \"your-client-secret\"\n        }\n    )\n\n    api = base_client.get_new_client_as(\"user.email@yourcompany.com\", customer_id=\"your-organization-id\")\n    ```\n\n3. Make your first API call\n\n    Let's display the full name of a registered user in lumapps\n\n    ```python\n    usr = api.get_call(\"user/get\", email=\"user.email@yourcompany.com\")\n    print(\"Hello {}\".format(usr[\"fullName\"]))\n    ```\n\n## Documentation\n\nThe SDK documentation is available [here](https://lumapps.github.io/lumapps-sdk/).\n\n## Code convention\n\nDocstring in PEP 484 type annotations format adapted to python 3.x using comments.\n\n## How to get help, contribute, or provide feedback\n\nPlease refer to our [contributing guidelines](CONTRIBUTING.md).\n\n## Copyright and license\n\nLumApps SDK is released under the [MIT license](LICENSE.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flumapps%2Flumapps-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flumapps%2Flumapps-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flumapps%2Flumapps-sdk/lists"}