Skip to content

Commit ac7d6bb

Browse files
author
Gareth
authored
Add TOC and beak out authentication section
1 parent 80d42fb commit ac7d6bb

File tree

1 file changed

+21
-9
lines changed

1 file changed

+21
-9
lines changed

README.md

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,27 @@
11
# Labelbox Python SDK
22

3-
Labelbox is the enterprise-grade training data solution with fast AI enabled labeling tools, labeling automation, human workforce, data management, a powerful API for integration & SDK for extensibility. Visit http://labelbox.com/ for more information.
3+
Labelbox is the enterprise-grade training data solution with fast AI enabled labeling tools, labeling automation, human workforce, data management, a powerful API for integration & SDK for extensibility. Visit [Labelbox](http://labelbox.com/) for more information.
44

55
The Labelbox Python API offers a simple, user-friendly way to interact with the Labelbox back-end.
66

7+
## Table of Contents
8+
9+
* [Requirements](#requirements)
10+
* [Installation](#installation)
11+
* [Authentication](#authentication)
12+
* [Documentation](#documentation)
13+
* [Contribution](#contribution)
14+
* [Testing](#testing)
15+
716
## Requirements
817

9-
* Use Python 3.6, 3.7 or 3.8.
10-
* Create an account by visiting http://app.labelbox.com/.
11-
* [Generate an API key](https://labelbox.com/docs/api/getting-started#create_api_key).
18+
* Use Python 3.6, 3.7 or 3.8
19+
* [Create an account](http://app.labelbox.com/)
20+
* [Generate an API key](https://labelbox.com/docs/api/getting-started#create_api_key)
1221

13-
## Installation & authentication
22+
## Installation
1423

15-
0. Prerequisite: Install pip
24+
Prerequisite: Install pip
1625

1726
`pip` is a package manager for Python. **On macOS**, you can set it up to use the default python3 install via -
1827
```
@@ -26,12 +35,15 @@ If the installation completes with a warning re: pip not being in your path, you
2635
export PATH=/Users/<your-macOS-username>/Library/Python/3.8/bin:$PATH
2736
```
2837

29-
1. Install using Python's Pip manager.
38+
Install using Python's Pip manager.
3039
```
3140
pip install labelbox
3241
```
3342

34-
2. Pass your API key as an environment variable. Then, import and initialize the API Client.
43+
## Authentication
44+
45+
Labelbox uses API keys to validate requests. You can create and manage API keys on [Labelbox](https://app.labelbox.com/account/api-keys). Pass your API key as an environment variable. Then, import and initialize the API Client.
46+
3547
```
3648
user@machine:~$ export LABELBOX_API_KEY="<your api key here>"
3749
user@machine:~$ python3
@@ -44,7 +56,7 @@ client = Client()
4456

4557
[Visit our docs](https://labelbox.com/docs/python-api) to learn how to [create a project](https://labelbox.com/docs/python-api/create-first-project), read through some helpful user guides, and view our [API reference](https://labelbox.com/docs/python-api/api-reference).
4658

47-
## Repo Organization and Contribution
59+
## Contribution
4860
Please consult `CONTRIB.md`
4961

5062
## Testing

0 commit comments

Comments
 (0)