Signed-off-by: Jess Frazelle <github@jessfraz.com>
This commit is contained in:
Jess Frazelle
2023-05-05 11:07:44 -07:00
parent dee61d7b08
commit a6638fb08a
3 changed files with 26 additions and 15 deletions

View File

@ -44,7 +44,13 @@ client = Client(token="$TOKEN")
# `KITTYCAD_API_TOKEN`. # `KITTYCAD_API_TOKEN`.
from kittycad import ClientFromEnv from kittycad import ClientFromEnv
client = ClientFromEnv()""", client = ClientFromEnv()
# NOTE: The python library additionally implements asyncio, however all the code samples we
# show below use the sync functions for ease of use and understanding.
# Check out the library docs at:
# https://python.api.docs.kittycad.io/_autosummary/kittycad.api.html#module-kittycad.api
# for more details.""",
"install": "pip install kittycad", "install": "pip install kittycad",
} }
@ -277,12 +283,8 @@ from kittycad.types import Response
# Add some new lines. # Add some new lines.
example_imports = example_imports + "\n\n" example_imports = example_imports + "\n\n"
example = ( short_sync_example = (
example_imports """def test_"""
+ """
@pytest.mark.skip
def test_"""
+ fn_name + fn_name
+ """(): + """():
# Create our client. # Create our client.
@ -293,7 +295,19 @@ def test_"""
+ fn_name + fn_name
+ """.sync(client=client,\n""" + """.sync(client=client,\n"""
+ params_str + params_str
+ """) + """)"""
)
# This longer example we use for generating tests.
# We only show the short example in the docs since it is much more intuitive to MEs
example = (
example_imports
+ """
@pytest.mark.skip
"""
+ short_sync_example
+ """
# OR if you need more info (e.g. status_code) # OR if you need more info (e.g. status_code)
""" """
@ -334,18 +348,16 @@ async def test_"""
line_length = 82 line_length = 82
cleaned_example = black.format_str( cleaned_example = black.format_str(
isort.api.sort_code_string( isort.api.sort_code_string(
example, short_sync_example,
), ),
mode=black.FileMode(line_length=line_length), mode=black.FileMode(line_length=line_length),
) )
examples.append(cleaned_example) examples.append(example)
# Add our example to our json output. # Add our example to our json output.
data["paths"][name][method]["x-python"] = { data["paths"][name][method]["x-python"] = {
"example": cleaned_example.replace("@pytest.mark.asyncio\n", "") "example": cleaned_example.replace("def test_", "def "),
.replace("def test_", "def ")
.replace("@pytest.mark.skip", ""),
"libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api." "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api."
+ tag_name + tag_name
+ "." + "."

File diff suppressed because one or more lines are too long

View File

@ -1,6 +1,6 @@
[tool.poetry] [tool.poetry]
name = "kittycad" name = "kittycad"
version = "0.3.9" version = "0.4.0"
description = "A client library for accessing KittyCAD" description = "A client library for accessing KittyCAD"
authors = [] authors = []