New build.

This commit is contained in:
bot 2024-12-02 16:50:25 +00:00
parent 4098355f8a
commit 2df6498f57
4 changed files with 37 additions and 0 deletions

Binary file not shown.

Binary file not shown.

View File

@ -10,3 +10,39 @@ Description-Content-Type: text/markdown
Requires-Dist: requests Requires-Dist: requests
Requires-Dist: aiohttp Requires-Dist: aiohttp
Requires-Dist: dataset 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

View File

@ -1,3 +1,4 @@
README.md
pyproject.toml pyproject.toml
setup.cfg setup.cfg
src/devranta/__init__.py src/devranta/__init__.py