Skip to content

Commit a5158cc

Browse files
committed
update readme
1 parent 9ee8115 commit a5158cc

1 file changed

Lines changed: 7 additions & 6 deletions

File tree

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# Fox/RenderBus cloud rendering Python API
2-
We provides a simple Python-based API for using our cloud rendering service. This is the official API that is maintained by Fox/RenderBus RD team. The API has been tested ok with python2.7.10 and requests 2.11.1
1+
# Fox Render Farm / Renderbus cloud rendering Python API
2+
We provide a simple Python-based API for using our cloud rendering service. This is the official API that is maintained by Fox Render Farm / Renderbus RD team. The API has been tested ok with python2.7.10 and requests 2.11.1
33

44
The latest version can always be found at
55
https://github.com/renderbus/python-api
@@ -8,23 +8,24 @@ https://github.com/renderbus/python-api
88
- requests (We already test ok with requests 2.11.1)
99

1010
## Submiting Step
11+
- You must have a Fox Render Farm / Renderbus account to use our service, then create a project and select the plugins you want to use on our web site before submiting.
1112

12-
- Login to our cloud server first. currently, some info like access_key need to ask us support team.
13+
- Login in our cloud server account first, some information such as access key, you need ask for our support team.
1314
```py
1415
fox = Fox(render_server="www5.renderbus.com", account="XXX", access_key="XXX", aspera_server="app5.renderbus.com", aspera_password="XXX")
1516
```
1617

17-
- Upload local files to cloud server, skip exists same files by default, you can upload the files and folders.
18+
- Upload local files or folders to cloud server and skip the existing same file by default.
1819
```py
1920
fox.upload(path_list=[r"v:\project\shot\lgt.ma", r"v:\project\asset\sourceimages"])
2021
```
2122

22-
- After all the dependancy files of Maya file has been uploaded, you can submit task to cloud server.
23+
- After all the dependancy files of Maya Task such as texture, cache etc have been uploaded, you can submit task to cloud server.
2324
```py
2425
fox.submit_task(project_name="XXX", input_scene_path=r"v:\project\shot\lgt.ma", frames="1-10[1]")
2526
```
2627

27-
- After render complete, you can download the entire task output files from cloud server, and single frame output files downloading is not supported yet currently. The download method would skip exists same files which already downloaded by default
28+
- After rendering complete, you can download the entire task output files from cloud server, but single frame download function is not supported yet. The download method will skip the existing same files which already downloaded by default.
2829
```py
2930
fox.download(task_id=11111, local_path=r"v:\project\output")
3031
```

0 commit comments

Comments
 (0)