{"id":15473483,"url":"https://github.com/seluj78/shellhub-python","last_synced_at":"2025-07-21T05:05:55.336Z","repository":{"id":219947662,"uuid":"749889604","full_name":"Seluj78/shellhub-python","owner":"Seluj78","description":"A Python SDK for shellhub (https://shellhub.io)","archived":false,"fork":false,"pushed_at":"2025-06-23T16:48:54.000Z","size":37,"stargazers_count":7,"open_issues_count":4,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-23T17:46:39.936Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Seluj78.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2024-01-29T15:47:00.000Z","updated_at":"2024-03-21T16:33:28.000Z","dependencies_parsed_at":"2024-07-22T20:10:03.593Z","dependency_job_id":"9ec024e2-1544-4148-9624-be607d20ea3d","html_url":"https://github.com/Seluj78/shellhub-python","commit_stats":{"total_commits":20,"total_committers":2,"mean_commits":10.0,"dds":"0.050000000000000044","last_synced_commit":"e9080a3010808ac87a04eef3a5ef5a62b70f0af0"},"previous_names":["seluj78/shellhub-python"],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/Seluj78/shellhub-python","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Seluj78%2Fshellhub-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Seluj78%2Fshellhub-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Seluj78%2Fshellhub-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Seluj78%2Fshellhub-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Seluj78","download_url":"https://codeload.github.com/Seluj78/shellhub-python/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Seluj78%2Fshellhub-python/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266242072,"owners_count":23898102,"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","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":[],"created_at":"2024-10-02T02:53:57.330Z","updated_at":"2025-07-21T05:05:55.321Z","avatar_url":"https://github.com/Seluj78.png","language":"Python","readme":"# [Shellhub Python SDK]\n\n[![codecov](https://codecov.io/gh/Seluj78/shellhub-python/graph/badge.svg?token=FPWuNDtwdz)](https://codecov.io/gh/Seluj78/shellhub-python)\n\n* [What is it](#what-is-it)\n* [Installation](#installation)\n   * [Locally](#locally)\n      * [Create a virtual environment](#create-a-virtual-environment)\n      * [Activate it](#activate-it)\n      * [Install the requirements](#install-the-requirements)\n      * [Edit the env file with the correct parametters](#edit-the-env-file-with-the-correct-parametters)\n      * [Install the module locally](#install-the-module-locally)\n* [Deployment](#deployment)\n* [Repository rules](#repository-rules)\n* [Code owner](#code-owner)\n\n\n## What is it\n\nThis repository contains the source code to a Shellhub (https://shellhub.io) Python SDK. It is used to interact with the Shellhub API.\n\nTested with shellhub `v0.14.1`\n\nOpen to all contributions, wether it is a bug fix, a new feature or a documentation improvement, or even a better way to do things.\n\n## Installation\n\nFrom pip: `pip install shellhub`\n\n### Locally\n\n#### Create a virtual environment\n```shell\npython3.11 -m venv venv\n```\nYou can use any version starting python `3.8`\n\n#### Activate it\n```shell\nsource venv/bin/activate\n```\n\n#### Install the requirements\n```shell\npip install -r requirements-dev.txt\n```\n\n#### Activate the pre-commit\n\n```shell\npip install pre-commit\npre-commit install\npre-commit install --hook commit-msg\n```\n\n#### Edit the env file with the correct parameters\n```shell\nvim .env\n```\n\n#### Install the module locally\n```shell\npython setup.py develop\n```\n\n## Deployment\n\nIn your Pull Request, make sure you have modified the version in `__init__.py` according to semver.org\nOnce done, and the PR is merged, you need to push on the `main` branch a tag with a `v` prefix\n\nFor example: If the `__version__` in `__init__.py` is `1.0.0`, you need to tag the last commit on main with your changes with `v1.0.0`\n\nProcedure:\n\n- Merge the PR\n- `git checkout main`\n- `git pull`\n- `git tag vx.x.x`\n- `git push --tags`\n\nOnce done, go to the repository, find the tag and create a release from the tag. In the description, explain what has changed so we can easily see what has been done\nA few seconds after, the package should be up in the pypi server.\n\n## Repository rules\n\nWhen contributing:\n\n- Create a branch based on `main`\n- Code on it and commit\n- Create PR\n- Wait for it to be approved and make sure all checks pass\n- Merge it\n\n## Code owner\n\njules.lasne@gmail.com\n\n## TODO:\n\n- [ ] Migrate tests to pytest-recording\n- [ ] Add a readthedocs documentation\n- [ ] Switch to an OpenAPI generated client ? see https://github.com/shellhub-io/shellhub/issues/3497#issuecomment-1917478654\n- [ ] Add deployment to pypi on merge to main\n- [ ] Add a changelog\n- [ ] Setup coverage reporting\n- [ ] Update tests to tests on multiple python versions","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fseluj78%2Fshellhub-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fseluj78%2Fshellhub-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fseluj78%2Fshellhub-python/lists"}