Skip to content

Commit 8b2ca05

Browse files
committed
Bump PyPi version to 0.0.3
1 parent 04765b0 commit 8b2ca05

File tree

4 files changed

+23
-24
lines changed

4 files changed

+23
-24
lines changed

.project

Lines changed: 0 additions & 17 deletions
This file was deleted.

.pydevproject

Lines changed: 0 additions & 5 deletions
This file was deleted.

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,50 @@
11
# sentinel-python-sdk
2+
23
A Sentinel SDK Written in Python
34

5+
## Install
6+
7+
This is now a PyPi package and can be installed directly with pip:
8+
9+
```shell
10+
pip install sentinel-sdk
11+
```
12+
413
### Packaging Python Projects references:
14+
515
- https://packaging.python.org/en/latest/tutorials/packaging-projects/
616
- https://packaging.python.org/en/latest/discussions/src-layout-vs-flat-layout/
717

818
### Development environment:
19+
920
https://setuptools.pypa.io/en/latest/userguide/development_mode.html
21+
1022
```bash
1123
python -m venv venv
1224
pip install --editable .
1325
```
1426

1527
Please install pre-commit plugin, in order to follow [PEP8](https://peps.python.org/pep-0008/)
28+
1629
```bash
1730
pip install pre-commit
1831
pre-commit install
1932
```
33+
2034
https://pre-commit.com/index.html
2135

2236
### Usage example:
37+
2338
```python
2439
from sentinel_sdk.sdk import SDKInstance
2540
from sentinel_sdk.types import Status, PageRequest
2641
sdk = SDKInstance("grpc.sentinel.co", 9090)
2742
nodes = sdk.nodes.QueryNodes(Status.ACTIVE)
2843
subscriptions = sdk.subscriptions.QuerySubscriptions(pagination=PageRequest(limit=5000, offset=0, reverse=True))
2944
```
45+
46+
## Coded with Love by:
47+
48+
[NAST0R · GitHub](https://github.com/NAST0R) , [Tkd-Alex (Alessandro Maggio) · GitHub](https://github.com/Tkd-Alex), ([freQniK · GitHub](https://github.com/freQniK))
49+
50+
**Commissioned by MathNodes** [MathNodes](https://github.com/MathNodes/sentinel-python-sdk)

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ build-backend = "hatchling.build"
44

55
[project]
66
name = "sentinel_sdk"
7-
version = "0.0.2"
7+
version = "0.0.3"
88
description = "A Sentinel SDK Written in Python"
99
authors = [
1010
{ name = "NAST0R" },
11-
{ name = "Tkd-Alex", email = "[email protected]" },
11+
{ name = "Tkd-Alex", email = "[email protected]" },
1212
{ name = "MathNodes", email = "[email protected]'" },
1313
]
1414
readme = "README.md"

0 commit comments

Comments
 (0)