New build.
This commit is contained in:
parent
4098355f8a
commit
2df6498f57
BIN
dist/devranta-1.0.0-py3-none-any.whl
vendored
BIN
dist/devranta-1.0.0-py3-none-any.whl
vendored
Binary file not shown.
BIN
dist/devranta-1.0.0.tar.gz
vendored
BIN
dist/devranta-1.0.0.tar.gz
vendored
Binary file not shown.
@ -10,3 +10,39 @@ Description-Content-Type: text/markdown
|
||||
Requires-Dist: requests
|
||||
Requires-Dist: aiohttp
|
||||
Requires-Dist: dataset
|
||||
|
||||
# devRanta
|
||||
|
||||
devRanta is an async devrant client written in and for Python.
|
||||
Authentication is only needed for half of the functionality and thus username and password are optional parameters by constructing the main class of this package (Api).
|
||||
|
||||
## Running
|
||||
```
|
||||
make run
|
||||
```
|
||||
|
||||
## Testing
|
||||
Tests are only made for methods not requireing authentication.
|
||||
I do not see value in mocking requests.
|
||||
```
|
||||
make test
|
||||
```
|
||||
|
||||
## How to use
|
||||
Implementation:
|
||||
```
|
||||
from devranta.api import Api
|
||||
|
||||
api = Api(username="optional!", password="optional!")
|
||||
|
||||
async def list_rants():
|
||||
async for rant in api.get_rants():
|
||||
print(rant["user_username"], ":", rant["text"])
|
||||
```
|
||||
See [tests](src/devranta/tests.py) for [examples](src/devranta/tests.py) on how to use.
|
||||
|
||||
## Todo
|
||||
|
||||
- voting comment
|
||||
- edit message
|
||||
|
||||
|
@ -1,3 +1,4 @@
|
||||
README.md
|
||||
pyproject.toml
|
||||
setup.cfg
|
||||
src/devranta/__init__.py
|
||||
|
Loading…
Reference in New Issue
Block a user