Skip to content

Commit 4201f50

Browse files
committed
README fix
1 parent 45a1359 commit 4201f50

File tree

2 files changed

+17
-17
lines changed

2 files changed

+17
-17
lines changed

README.rst

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,9 @@ Resources
2727

2828
- API Reference and User Guide available on `Read the Docs <https://superannotate.readthedocs.io/en/stable/superannotate.sdk.html>`_
2929
- `Platform documentation <https://doc.superannotate.com/>`_
30-
Authentication
3130

31+
32+
Authentication
3233
---------------
3334

3435
.. code-block:: python
@@ -37,52 +38,51 @@ Authentication
3738
# by environment variable SA_TOKEN
3839
sa_client = SAClient()
3940
# by token
40-
sa_client = SAClient(token=<team token>)
41+
sa_client = SAClient(token='<team token>')
4142
# by config file
4243
# default path is ~/.superannotate/config.json
43-
sa_client = SAClient(config_path=~/.superannotate/dev_config.json)
44+
sa_client = SAClient(config_path='~/.superannotate/dev_config.json')
4445
4546
Using superannotate
4647
-------------------
4748

4849
.. code-block:: python
4950
50-
:linenos:
5151
from superannotate import SAClient
5252
sa_client =SAClient()
53-
project = Dogs
53+
project = 'Dogs'
5454
sa_client.create_project(
5555
project_name=project,
56-
project_description=Test project generated via SDK,
57-
project_type=Vector
56+
project_description='Test project generated via SDK',
57+
project_type='Vector'
5858
)
5959
sa_client.create_annotation_class(
6060
project=project,
61-
name=dog,
62-
color=#F9E0FA,
63-
class_type=tag
61+
name='dog',
62+
color='#F9E0FA',
63+
class_type='tag'
6464
)
6565
sa_client.attach_items(
6666
project=project,
6767
attachments=[
6868
{
69-
url”: “https://drive.google.com/uc?export=download&id=1ipOrZNSTlPUkI_hnrW9aUD5yULqqq5Vl,
70-
name”: “dog.jpeg
69+
'url': 'https://drive.google.com/uc?export=download&id=1ipOrZNSTlPUkI_hnrW9aUD5yULqqq5Vl',
70+
'name': 'dog.jpeg'
7171
}
7272
]
7373
)
7474
sa_client.upload_annotations(
7575
project=project,
7676
annotations=[
7777
{
78-
metadata: {name”: “dog.jpeg},
79-
instances: [
80-
{type”: “tag”, “className”: “dog}
78+
'metadata': {'name': 'dog.jpeg'},
79+
'instances': [
80+
{'type': 'tag', 'className': 'dog'}
8181
]
8282
}
8383
]
8484
)
85-
sa_client.get_annotations(project=project, items=[dog.jpeg])
85+
sa_client.get_annotations(project=project, items=['dog.jpeg'])
8686
8787
Installation
8888
------------

tests/integration/annotations/test_upload_annotations_from_folder_to_project.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ def test_upload_large_annotations(self):
9595
def test_upload_big_annotations(self):
9696
sa.attach_items(
9797
self.PROJECT_NAME,
98-
[{"name": f"aearth_mov_00{i}.jpg", "url": f"url_{i}"} for i in range(1, 6)] # noqa
98+
[{"name": f" rst-lintaearth_mov_00{i}.jpg", "url": f"url_{i}"} for i in range(1, 6)] # noqa
9999
)
100100
sa.create_annotation_classes_from_classes_json(
101101
self.PROJECT_NAME, f"{self.big_annotations_folder_path}/classes/classes.json"

0 commit comments

Comments
 (0)