docs: updating docs for the issue on python 3.12 (#332)

* docs: add docs for python 312 compatibility * docs: change wording and marked as important * docs: tweaking alert on readme * chore: pip audit fixes * docs: tweaking title --------- Co-authored-by: Altynbek Orumbayev <[email protected]>
algorandfoundation · Oct 19, 2023 · 288b561 · 288b561 · github-actions · Oct 19, 2023
1 parent 991756f
commit 288b561
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -85,6 +85,9 @@ This is an open source project managed by the Algorand Foundation. See the [cont
 
 The key required dependency is Python 3.10+, but some of the installation options below will install that for you.
 
+> **IMPORTANT**  
+> Due to [`aiohttp`](https://github.com/aio-libs/aiohttp/issues/7675) dependency compatibility issues with Python 3.12, we advise using Python versions up to 3.11 for now. This is a temporary measure until stable release of `aiohttp` with 3.12 support is available.
+
 AlgoKit also has some runtime dependencies that also need to be available for particular commands.
 
 > **Note**

diff --git a/poetry.lock b/poetry.lock
File	Stmts	Miss	Cover	Missing
src/algokit
__init__.py	15	7	53%	6–13, 17–24, 32–34
__main__.py	2	2	0%	1–3
src/algokit/cli
completions.py	105	2	98%	80, 95
deploy.py	56	5	91%	34–36, 78, 96
dispenser.py	116	1	99%	74
doctor.py	48	3	94%	142–144
generate.py	57	1	98%	116
goal.py	39	1	97%	57
init.py	190	16	92%	272–273, 323, 326–328, 339, 383, 409, 449, 458–460, 463–468, 481
localnet.py	93	3	97%	162, 183–184
src/algokit/core
bootstrap.py	161	24	85%	103–104, 126, 149, 214, 217, 223–237, 246–251
conf.py	54	8	85%	10, 24, 28, 36, 38, 71–73
deploy.py	69	11	84%	61–64, 73–75, 79, 84, 91–93
dispenser.py	202	26	87%	88, 120–121, 138–146, 188–189, 195–197, 215–216, 256–257, 315, 329–331, 342–343, 353, 366, 381
doctor.py	65	7	89%	67–69, 92–94, 134
generate.py	41	2	95%	68, 86
goal.py	56	3	95%	27–28, 38
log_handlers.py	68	7	90%	50–51, 63, 112–116, 125
proc.py	45	1	98%	98
sandbox.py	181	15	92%	100–107, 118, 278, 294, 309–311, 327
typed_client_generation.py	80	5	94%	55–57, 70, 75
utils.py	18	2	89%	27–28
version_prompt.py	73	8	89%	27–28, 40, 59–62, 80, 109
TOTAL	1990	160	92%