Skip to content
This repository was archived by the owner on Apr 4, 2024. It is now read-only.

Commit 7f70541

Browse files
committed
Improve the README.
1 parent 142094a commit 7f70541

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

python/README.md

+10-7
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
The python implementation is under construction. It makes use of PEP 695, so you must use Python 3.12 or later.
22

3-
Dependencies are managed using poetry
3+
Dependencies are managed using poetry, which you can install here.
44
- https://python-poetry.org/docs/#installing-with-the-official-installer
5+
- then cd into `selfie-lib` and run `poetry install`
56

6-
Testing via pytest (built-in to the VSCode Python plugin)
7-
- https://marketplace.visualstudio.com/items?itemName=ms-python.python
7+
Our CI server runs three checks in the `selfie-lib` directory.
8+
9+
- `poetry run pytest -vv` this runs the tests (`-vv` makes nice output)
10+
- `poetry run pyright` this does type checking
11+
- `poetry run ruff check` this checks formatting
812

9-
Types are declared using [PEP 695](https://peps.python.org/pep-0695/), and checked via pyright
10-
- https://marketplace.visualstudio.com/items?itemName=ms-pyright.pyright
13+
For the IDE we use VSCode. Make sure to open the `python` directory, not the parent `selfie`. Receommended VSCode plugins:
1114

12-
Formatting via ruff
13-
- https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff
15+
- https://marketplace.visualstudio.com/items?itemName=ms-python.python
16+
- https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff

0 commit comments

Comments
 (0)