Skip to content

Commit 2fe8b03

Browse files
authored
Clarifying namings inside README.md
1 parent 39d7056 commit 2fe8b03

1 file changed

Lines changed: 30 additions & 1 deletion

File tree

‎README.md‎

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,31 @@
1-
# bodyloop-pypi
1+
# BodyLoop SDK for Python
2+
23
Python SDK for the BodyLoop API for seamless ecosystem integration
4+
5+
The URL of the source repository <https://github.com/bodyloop/bodyloop-sdk-python> has suffix `python` to enable adding SDKs for other lanuages such as JavaScript/TypeScript, C/C++, Rust, etc.
6+
7+
The distribution name (install) of the Python Package name is `bodyloop-sdk` and is available in the global Package Index PyPi at <https://pypi.org/project/bodyloop-sdk>. It omits the suffix since PyPi already tells us that we are in the Python ecosystem.
8+
9+
Examples how to get the package are:
10+
11+
```bash
12+
pip install bodyloop-sdk
13+
14+
poetry add bodyloop-sdk
15+
16+
uv add bodyloop-sdk
17+
18+
pipx install bodyloop-sdk
19+
20+
uv tool install bodyloop-sdk
21+
```
22+
23+
The top-level import of the package is the Python module `bodyloop`.
24+
25+
Usage:
26+
27+
```python
28+
import bodyloop
29+
from bodyloop import Viatar, Proband
30+
from bodyloop import System as BodyLoopSystem
31+
```

0 commit comments

Comments
 (0)