Loading README.md +34 −12 Original line number Diff line number Diff line Loading @@ -4,16 +4,28 @@ This repo contains the implementation of the *RSVP (Request-and-Stream Variable The general protocol is described in more details [here][1]. ## Dependencies ## Add pyrsvp to your project | | | |-|-| | Poetry | >= 1.2.0 | The CI publishes a *pypy* package on gitlab. This package can be used in other projects. Install python packages: ### Add pyrsvp to Poetry project Add a secondary source to your poetry project ```bash poetry install poetry source add -s igib https://labinfo.ing.he-arc.ch/gitlab/api/v4/projects/2369/packages/pypi/simple ``` Add *pyrsvp* package ```bash poetry add pyrsvp --source igib ``` ### Add using PIP ```bash pip install pyrsvp --index-url https://labinfo.ing.he-arc.ch/gitlab/api/v4/projects/2369/packages/pypi/simple/ ``` ## Quick start Loading Loading @@ -124,19 +136,29 @@ All type are checked when creating a new object and it will raise an *RsvpWrongT In the *examples* folder you'll find some usage examples ## Run tests ## Developers ### Dependencies | | | |-|-| | Poetry | >= 1.2.0 | Install python dependencies: ```bash poetry run pytest -v -s tests poetry install ``` ## Add pyrsvp to your project ### Run tests Coming soon ```bash poetry run pytest -v -s tests ``` ## TODO list ### TODO list - [ ] Add CI/CD for tests and wheel generation - [X] Add CI/CD for tests and wheel generation - [ ] Add serial support [1]:https://labinfo.ing.he-arc.ch/gitlab/igib/documents-latex/rsvp-specs No newline at end of file Loading
README.md +34 −12 Original line number Diff line number Diff line Loading @@ -4,16 +4,28 @@ This repo contains the implementation of the *RSVP (Request-and-Stream Variable The general protocol is described in more details [here][1]. ## Dependencies ## Add pyrsvp to your project | | | |-|-| | Poetry | >= 1.2.0 | The CI publishes a *pypy* package on gitlab. This package can be used in other projects. Install python packages: ### Add pyrsvp to Poetry project Add a secondary source to your poetry project ```bash poetry install poetry source add -s igib https://labinfo.ing.he-arc.ch/gitlab/api/v4/projects/2369/packages/pypi/simple ``` Add *pyrsvp* package ```bash poetry add pyrsvp --source igib ``` ### Add using PIP ```bash pip install pyrsvp --index-url https://labinfo.ing.he-arc.ch/gitlab/api/v4/projects/2369/packages/pypi/simple/ ``` ## Quick start Loading Loading @@ -124,19 +136,29 @@ All type are checked when creating a new object and it will raise an *RsvpWrongT In the *examples* folder you'll find some usage examples ## Run tests ## Developers ### Dependencies | | | |-|-| | Poetry | >= 1.2.0 | Install python dependencies: ```bash poetry run pytest -v -s tests poetry install ``` ## Add pyrsvp to your project ### Run tests Coming soon ```bash poetry run pytest -v -s tests ``` ## TODO list ### TODO list - [ ] Add CI/CD for tests and wheel generation - [X] Add CI/CD for tests and wheel generation - [ ] Add serial support [1]:https://labinfo.ing.he-arc.ch/gitlab/igib/documents-latex/rsvp-specs No newline at end of file