42 lines
856 B
Markdown
42 lines
856 B
Markdown
# wiistream (gibb better name)
|
|
|
|
## Dev setup
|
|
|
|
I'm using some wacky pip alternative called poetry for shits and giggles. You could probably fuck around with a regular venv/pip instead butit might just be easier to blindly follow
|
|
|
|
* Setup poetry https://python-poetry.org/docs/
|
|
* cd to this folder
|
|
* ```poetry install```
|
|
|
|
This creates the venv and installs the exact packages I've been using
|
|
|
|
can also do stuff like running it with
|
|
|
|
```poetry run wiistream```
|
|
|
|
```poetry run pytest```
|
|
|
|
```poetry run black```
|
|
|
|
There's some githooks setup to auto format it with black. that is the style.
|
|
|
|
Think you might also have to setup the githooks yourself on your end if you care
|
|
|
|
use the
|
|
|
|
```pre-commit run --all-files```
|
|
|
|
and
|
|
|
|
```pre-commit install```
|
|
|
|
commands to do it
|
|
|
|
|
|
## Todo
|
|
|
|
* actually document
|
|
* networking stuff
|
|
* intergrate with compression
|
|
* test? 🤮
|