Skip to content

Commit 56c9ed0

Browse files
committed
Minor README updates
1 parent 13f9af5 commit 56c9ed0

File tree

1 file changed

+17
-7
lines changed

1 file changed

+17
-7
lines changed

README.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,38 @@
11
# Temporal Python SDK
22

3-
### Local development enviroment
3+
**UNDER DEVELOPMENT**
44

5-
- Install the system dependencies
5+
The Python SDK is under development. There are no compatibility guarantees nor proper documentation pages at this time.
6+
7+
### Local development environment
8+
9+
- Install the system dependencies:
610

711
- Python >=3.7
8-
- [pipx](https://github.com/pypa/pipx#install-pipx)
9-
- [`poetry`](https://github.com/python-poetry/poetry) `pipx install poetry`
10-
- [`poe`](https://github.com/nat-n/poethepoet) `pipx install poethepoet`
12+
- [pipx](https://github.com/pypa/pipx#install-pipx) (only needed for installing the two dependencies below)
13+
- [poetry](https://github.com/python-poetry/poetry) `pipx install poetry`
14+
- [poe](https://github.com/nat-n/poethepoet) `pipx install poethepoet`
1115

1216
- Use a local virtual env environment (helps IDEs and Windows):
1317

1418
```bash
1519
poetry config virtualenvs.in-project true
1620
```
1721

18-
- Install the package dependencies
22+
- Install the package dependencies:
1923

2024
```bash
2125
poetry install
2226
```
2327

24-
- Build the project
28+
- Build the project:
2529

2630
```bash
2731
poe build
2832
```
33+
34+
- Run the tests:
35+
36+
```bash
37+
poe test
38+
```

0 commit comments

Comments
 (0)