studio-api

[jonathanfeng-scale]

Pull Request Summary

Description

Studio API endpoints

TODO BEFORE MERGE:

• still need to update public readme
• look into deploy checklist
• increment sdk version
• Release summary pre-write

How did you test your code?

included a t_studio.py file since Studio endpoints require live projects

Checklist

Please make sure all items in this checklist have been fulfilled before sending your PR out for review!

• I have commented my code in details, particularly in hard-to-understand areas
• I have updated Readme.rst document with examples for newly implemented public methods
• I have reviewed Deployment and Publishing Guide for Python SDK document
• I incremented the SDK version in _version.py (unless this PR only updates the documentation).
• In order to release a new version, a "Release Summary" needs to be prepared and published after the merge

[jonathanfeng-scale]

@rodsca @lautarorangil left some comments on the latest PR

We need to be sure that our type-hints for each method are returning the correct types.

I'm seeing a couple of "Dict" instead of "List"

I think it'll be best to follow the google-docs version of the Studio API stuff since it contains examples of what the expected responses should be.

https://docs.google.com/document/d/1q9v4u5uOpvjHZSxv9p49787eqC49DkKZz2QC8A_GjHc/edit

[fatihkurtoglu]

Thanks for those great additions to the SDK! Left some comments.

[fatihkurtoglu]

can those list tests assure something, other than just calling the endpoint?
i.e. there are some test cases it creates some data first, then tests if it pulls them correctly

scaleapi-python-client/tests/test_client.py

Lines 406 to 423 in 5fd9adb

	def test_batches():
	batches = []
	for _ in range(3):
	batches.append(create_a_batch())
	batch_names = {batch.name for batch in batches}
	for batch in client.batches(limit=3):
	assert batch.name in batch_names
	def test_get_batches():
	# Get count of all batches
	batchlist = client.batches(project=TEST_PROJECT_NAME, limit=1)
	total_batches = batchlist.total
	# Download all batches to check total count
	all_batches = list(client.get_batches(project_name=TEST_PROJECT_NAME))
	assert total_batches == len(all_batches)

[jonathanfeng-scale]

Yeah that'll definitely be better.

[jonathanfeng-scale]

@lautarorangil can you add a couple of teammates, and compare the lens to create some tests