Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changes from 1.1.0 publish #10

Merged
merged 2 commits into from
Jan 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ pip install supergood

Set the environment variables `SUPERGOOD_CLIENT_ID` and `SUPERGOOD_CLIENT_SECRET` using the API keys generated in the [getting started instructions](../getting-started.md).

Initialize the Supergood client at the root of your application, or anywhere you're making API calls with the following code:
Initialize the Supergood client at the root of your application, or anywhere you're making API calls.

```python
from Supergood import Client
Expand All @@ -24,8 +24,8 @@ Client()

**Passing keys**

You can also pass the API keys in manually without setting environment variables.\
\
You can also pass the API keys in manually without setting environment variables.

Replace `<CLIENT_ID>` and `<CLIENT_SECRET>` with the API keys you generated in the [getting started instructions](../getting-started.md).

```python
Expand All @@ -34,6 +34,8 @@ from Supergood import Client
Client(client_id="<CLIENT_ID>", client_secret="<CLIENT_SECRET>")
```

Note: If your application makes use of the `multiprocessing` library to make API calls, you'll need to initialize a client for each `Process`.&#x20;

## 3. Monitor your API calls

You're all set to use Supergood!
Expand Down
2 changes: 1 addition & 1 deletion publish.sh
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ source .env
rm -rf dist

# Pull latest README.md from Gitbook
curl -C - -0 https://raw.githubusercontent.com/supergoodsystems/docs/287d642c47fb485c9b5d7e4271ec07146a733358/installing-clients/python.md > README.md
curl -C - -0 https://raw.githubusercontent.com/supergoodsystems/docs/main/installing-clients/python.md > README.md
git add README.md
git commit -m "Update README.md"

Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[bumpversion]
current_version = 1.0.22
current_version = 1.1.0
commit = True
tag = True

Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

setuptools.setup(
name="supergood",
version="1.0.22",
version="1.1.0",
author="Alex Klarfeld",
description="The Python client for Supergood",
long_description=long_description,
Expand Down