Skip to content
Snippets Groups Projects
Commit 5721662e authored by Ivar Matstoms's avatar Ivar Matstoms
Browse files

Update docs and readme.md

parent e8481cd1
No related branches found
No related tags found
No related merge requests found
...@@ -6,6 +6,7 @@ ...@@ -6,6 +6,7 @@
pages/quick-start pages/quick-start
pages/protocol pages/protocol
pages/client pages/client
pages/utils
pages/development pages/development
``` ```
...@@ -20,3 +20,9 @@ Generate errors ...@@ -20,3 +20,9 @@ Generate errors
```bash ```bash
python -m tools.codegen errors errors.json python -m tools.codegen errors errors.json
``` ```
## Running tests
To run tests, make sure that `pytest` is installed and simply run:
```bash
pytest
```
\ No newline at end of file
# Protocol # Protocol
The protocol module subpackage implements LysKOM types as well as a parser and writer for encoding/decoding.
## Base ## Base
```{eval-rst} ```{eval-rst}
.. automodule:: pyskom.protocol.base .. automodule:: pyskom.protocol.base
......
# Utils
## Text-no utils
```{eval-rst}
.. automodule:: pyskom.utils.text_no
:members:
:undoc-members:
```
from .text_no import read_to_unread from .text_no import read_to_unread, text_block_to_list
\ No newline at end of file \ No newline at end of file
# TODO # PysKOM
* Types Pyskom is a LysKOM library written in Python.
* Arrays
* ... ## Documentation
* Protocol A writer [https://www.lysator.liu.se/~ivma/pyskom/docs/index.html](https://www.lysator.liu.se/~ivma/pyskom/docs/index.html)
\ No newline at end of file \ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment