Skip to content

Commit d8a0f16

Browse files
committed
minor tweaks to readme and added isort as dev dep
1 parent d26b381 commit d8a0f16

File tree

3 files changed

+22
-3
lines changed

3 files changed

+22
-3
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,14 +62,15 @@ import mystbin
6262
import requests
6363

6464
sync_session = requests.Session()
65-
mystbin_client = mystbin.Client(session=sync_session) ## optional api_key kwarg also
65+
mystbin_client = mystbin.Client(session=sync_session)
66+
#NOTE: The `api_key` kwarg in the Client constructor is optional.
6667

6768
paste = mystbin_client.post("Hello from sync Mystb.in!", syntax="text")
6869
str(paste)
6970
>>> 'https://mystb.in/<your generated ID>.text'
7071
```
7172

72-
NOTE: the session - aiohttp or requests - will have their default headers changed during init to support the Authorization header with the api key if present, and there is a timeout of 15s for each operation.
73+
NOTE: There is a timeout of 15s for each operation.
7374

7475
### Dependencies
7576

poetry.lock

Lines changed: 18 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ setuptools = "^50.3.0"
3838
wheel = "^0.35.1"
3939
black = "^20.8b1"
4040
flake8 = "^3.8.4"
41+
isort = "^5.8.0"
4142

4243
[tool.poetry.extras]
4344
requests = ["requests"]

0 commit comments

Comments
 (0)