https://github.com/ranchcomputing/python-sdk
https://github.com/ranchcomputing/python-sdk
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ranchcomputing/python-sdk
- Owner: ranchcomputing
- Created: 2024-03-21T10:09:54.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-09T15:18:47.000Z (about 2 years ago)
- Last Synced: 2025-08-20T05:36:51.772Z (11 months ago)
- Language: Python
- Size: 46.9 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README-DEV.md
Awesome Lists containing this project
README
## Create setup.py
### On Mac/Linux:
```bash
- touch setup.py
```
## Create new virtual environment
```bash
- python -m venv env
```
## Create .pypirc file in $HOME directory
```bash
touch ~/.pypirc
```
## Activate the environment
# On Mac/Linux:
```bash
source env/bin/activate
```
## On Windows:
```powershell
call env\Scripts\activate.bat
```
## updrade pip
```bash
- python -m pip install --upgrade pip
```
## Install wheel and twine
```bash
- pip install wheel
- pip install twine
```
## Run setup
```bash
- python setup.py bdist_wheel
```
## Check if dist is correct setup
```bash
- twine check dist/*
```
## upload test package with twine to [test.pypi](https://test.pypi.org/manage/account/)
```bash
twine upload -r test-ranch-pypi dist/*
```
## upload package with twine
```bash
- twine upload -r pypi dist/*
```
## Install nox
```bash
- pip install nox
```
## Testing package
```bash
- pip install -e .
- import ranch
- ranch.__version__
```
## Generate sphinx docs
```bash
- cd ranch-sdk-python
- nox
```
### Ranch SDK workflow
```mermaid
graph TD;
client{Client} --> ranchSdk(Ranch SDK);
ranchSdk --> createArchive(Create archive);
ranchSdk --> download(Download);
createArchive --> ranchecker(RANCHecker);
ranchSdk --> createBucket(Create buckets);
createBucket --> uploadAssets(Upload assets);
uploadAssets --> api;
ranchecker --> submitJob(Submit job);
download --> finishedJob(Finished job);
finishedJob --> api(API);
submitJob --> api(API);
ranchSdk --> userInfo(User infos);
userInfo --> api(API);
api --> sweb(Sweb);
sweb --> renderFarm(Ranch Render farm);
```
# Bucket
```mermaid
graph TD;
client{Client} --> client-rclone
client{Client} --> ranchsync
client{Client} --> ranchsdk
client{Client} --> boto3
client-rclone(Rclone) --> bucket(Bucket);
ranchsync(Ranchsync) --> bucket;
ranchsdk(Ranch sdk) --> bucket;
boto3(Boto3) --> bucket;
node-rclone(RClone) <--> node(Node);
bucket <--> node-rclone;
scalc-rclone(RClone) <--> scalc(Scalc);
bucket <--> scalc-rclone ;
```