Skip to content

Commit

Permalink
Merge pull request #8 from ndimares/patch-2
Browse files Browse the repository at this point in the history
Beautify Readme
  • Loading branch information
tylerhoran authored Apr 3, 2023
2 parents d861b4f + 38bb1f9 commit 6f5ec64
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
# Structure
<div align="center">
<picture>
<source srcset="https://user-images.githubusercontent.com/6267663/229523981-b357a689-adc6-4905-ac0e-e432aee5800b.png" media="(prefers-color-scheme: dark)">
<img src="https://user-images.githubusercontent.com/6267663/229523981-b357a689-adc6-4905-ac0e-e432aee5800b.png">
</picture>
<h1>Python SDK</h1>
<p>Discover rich information on people and companies</p>
<a href="https://docs.structure.ac/"><img src="https://img.shields.io/static/v1?label=Docs&message=API Ref&color=2564ec&style=for-the-badge" /></a>
<a href="https://github.com/structure-ac/structure-python/actions"><img src="https://img.shields.io/github/actions/workflow/status/structure-ac/structure-python/speakeasy_sdk_generation.yml?style=for-the-badge" /></a>
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge" /></a>
<a href="https://github.com/structure-ac/structure-python/releases"><img src="https://img.shields.io/github/v/release/structure-ac/structure-python?sort=semver&style=for-the-badge" /></a>
</div>

<!-- Start SDK Installation -->
## SDK Installation
Expand All @@ -8,6 +19,12 @@ pip install structure_py
```
<!-- End SDK Installation -->

## Authentication
You'll need to authenticate your requests to access any of the endpoints in the Structure API. In this guide, we'll look at how authentication works. Structure offers authentication for your API requests with a token.

### OAuth2 with bearer token
Authentication with the Structure API is using OAuth2. When establishing a connection using OAuth2, you will need your access token — you will find it in the [Structure dashboard](https://www.structure.ac/api_tokens) under API settings.

## SDK Example Usage
<!-- Start SDK Example Usage -->
```python
Expand Down

0 comments on commit 6f5ec64

Please sign in to comment.