{"id":30591871,"url":"https://github.com/ranchcomputing/python-sdk","last_synced_at":"2025-08-29T17:41:13.935Z","repository":{"id":228971626,"uuid":"775397237","full_name":"ranchcomputing/python-sdk","owner":"ranchcomputing","description":null,"archived":false,"fork":false,"pushed_at":"2024-04-09T15:18:47.000Z","size":48,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-08-20T05:36:51.772Z","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/ranchcomputing.png","metadata":{"files":{"readme":"README-DEV.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}},"created_at":"2024-03-21T10:09:54.000Z","updated_at":"2024-04-03T14:41:44.000Z","dependencies_parsed_at":"2024-04-03T16:45:44.455Z","dependency_job_id":null,"html_url":"https://github.com/ranchcomputing/python-sdk","commit_stats":null,"previous_names":["ranchcomputing/python-sdk"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ranchcomputing/python-sdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ranchcomputing%2Fpython-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ranchcomputing%2Fpython-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ranchcomputing%2Fpython-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ranchcomputing%2Fpython-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ranchcomputing","download_url":"https://codeload.github.com/ranchcomputing/python-sdk/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ranchcomputing%2Fpython-sdk/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272733411,"owners_count":24984262,"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-08-29T02:00:10.610Z","response_time":87,"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":[],"created_at":"2025-08-29T17:41:09.853Z","updated_at":"2025-08-29T17:41:13.895Z","avatar_url":"https://github.com/ranchcomputing.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Create setup.py\n### On Mac/Linux:\n```bash\n- touch setup.py \n```\n \n## Create new virtual environment\n```bash\n- python -m venv env\n```\n\n## Create .pypirc file in $HOME directory\n```bash\ntouch ~/.pypirc\n```\n\n## Activate the environment\n# On Mac/Linux:\n```bash\nsource env/bin/activate\n```\n\n## On Windows:\n```powershell\ncall env\\Scripts\\activate.bat\n```\n\n## updrade pip\n```bash\n- python -m pip install --upgrade pip\n```\n\n## Install wheel and twine\n```bash\n- pip install wheel\n- pip install twine\n```\n\n\n\n## Run setup\n```bash\n- python setup.py bdist_wheel\n```\n\n## Check if dist is correct setup\n```bash\n- twine check dist/*\n```\n\n## upload test package with twine to [test.pypi](https://test.pypi.org/manage/account/)\n```bash\ntwine upload -r test-ranch-pypi dist/*\n```\n\n## upload package with twine\n```bash\n- twine upload -r pypi dist/*\n```\n\n## Install nox\n```bash\n- pip install nox\n```\n\n## Testing package\n```bash\n- pip install -e .\n- import ranch\n- ranch.__version__\n```\n\n## Generate sphinx docs\n```bash\n- cd ranch-sdk-python\n- nox\n```\n\n### Ranch SDK workflow\n\n```mermaid\n  graph TD;\n      client{Client} --\u003e ranchSdk(Ranch SDK);\n      ranchSdk --\u003e createArchive(Create archive);\n      ranchSdk --\u003e download(Download);\n      createArchive --\u003e ranchecker(RANCHecker);\n      ranchSdk --\u003e createBucket(Create buckets);\n      createBucket --\u003e uploadAssets(Upload assets);\n      uploadAssets --\u003e api;\n      ranchecker --\u003e submitJob(Submit job);\n      download --\u003e finishedJob(Finished job);\n      finishedJob --\u003e api(API);\n      submitJob --\u003e api(API);\n      ranchSdk --\u003e userInfo(User infos);\n      userInfo --\u003e api(API);\n      api --\u003e sweb(Sweb);\n      sweb --\u003e renderFarm(Ranch Render farm);\n```\n\n\n# Bucket\n\n```mermaid\n  graph TD;\n      client{Client} --\u003e client-rclone\n      client{Client} --\u003e ranchsync\n      client{Client} --\u003e ranchsdk\n      client{Client} --\u003e boto3\n      client-rclone(Rclone) --\u003e bucket(Bucket);\n      ranchsync(Ranchsync) --\u003e bucket;\n      ranchsdk(Ranch sdk) --\u003e bucket;\n      boto3(Boto3) --\u003e bucket;\n      \n      node-rclone(RClone) \u003c--\u003e node(Node);\n      bucket \u003c--\u003e node-rclone;\n\n      scalc-rclone(RClone) \u003c--\u003e scalc(Scalc);\n      bucket \u003c--\u003e scalc-rclone ;\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Franchcomputing%2Fpython-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Franchcomputing%2Fpython-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Franchcomputing%2Fpython-sdk/lists"}