Skip to content

Commit

Permalink
point to actual pypi index + minor docs adjustments
Browse files Browse the repository at this point in the history
  • Loading branch information
MauriceKuenicke committed Apr 12, 2024
1 parent 9ee6a7a commit 989a132
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ jobs:
env:
TWINE_USERNAME: __token__
TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
run: twine upload --repository testpypi dist/*
run: twine upload dist/*

deploy:
needs: release
Expand Down
21 changes: 16 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,22 @@
This project is in early development and currently not safe for use in a production environment. Use at your own risk.

---

## Installation
<div class="termy">

```console
$ pip install tursopy


---> 100%

Installing collected packages: tursopy
Successfully installed tursopy-0.0.2
```

</div>

## Example Usage
```py
from tursopy import TursoClient
Expand Down Expand Up @@ -56,14 +72,10 @@ TursoPy models mirror the Turso platform API response models as much as possible
to access the data just by looking at the platform documentation. TursoPy sometimes flattens the responses if it makes
sense. This happens mostly for response models which only contain a single field with data.

<div class="termy">

```console
$ curl -L https://api.turso.tech/v1/organizations/your-org/databases -H 'Authorization: Bearer YOUR-TOKEN'


---> 100%

{
"databases": [
{
Expand All @@ -90,7 +102,6 @@ $ curl -L https://api.turso.tech/v1/organizations/your-org/databases -H 'Authori
}
```

</div>

In those cases,
you'll be able to access the data directly without going through that extra level.
Expand Down

0 comments on commit 989a132

Please sign in to comment.