docs: improve onboarding experience

- Update README to make the requirement for an activated poetry virtual-env clearer. - Update debug module to run --version command if there is no args.in - Update VSCode launch to use debugpy
algorandfoundation · Feb 5, 2024 · a4d6bb5 · a4d6bb5 · github-actions · Feb 5, 2024
1 parent 8477886
commit a4d6bb5
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 5 deletions.
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -6,7 +6,7 @@
   "configurations": [
     {
       "name": "Python: Module",
-      "type": "python",
+      "type": "debugpy",
       "cwd": "${workspaceFolder}",
       "request": "launch",
       "module": "debug",

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -18,17 +18,17 @@ AlgoKit development is done within the [AlgoKit Guiding Principles](./docs/algok
    - Manually:
      - Install `Python` - [Link](https://www.python.org/downloads/): The minimum required version is `3.10`, but `3.11` is recommended.)
      - Install `Poetry` - [Link](https://python-poetry.org/docs/#installation): The minimum required version is `1.2`.
-     - If you're not using PyCharm, then run `poetry install` in the root directory (this should set up `.venv` and install all Python dependencies - PyCharm will do this for you on startup)
+     - If you're not using PyCharm, then run `poetry install` in the repository root directory (this should set up `.venv` and install all Python dependencies - PyCharm will do this for you on startup)
    - Via AlgoKit CLI:
 
      - [Install AlgoKit CLI](./README.md#install) and run `algokit bootstrap poetry` in the root directory
      - Install `tealer` - by running `pipx install git+https://github.com/algorandfoundation/tealer@3-12`. This is a prerequisite to running `pytest`, tealer is a third party tool for static analysis of TEAL code, algokit uses it in `task analyse` command. AlgoKit uses `pytest-xdist` to speed up the test suite execution by running tests in parallel, this requires `tealer` to be installed globally to avoid race conditions.
 
 3. Install pre-commit hooks (optional but recommended):
 
-   [pre-commit](https://pre-commit.com/) is configured in this repository, so once `poetry install` has been run,
-   execute `pre-commit install` inside the virtual-env, and git will ensure formatting, linting, and static typing (via `mypy`)
-   is correct when you perform a commit.
+   [pre-commit](https://pre-commit.com/) is configured in this repository. To enable it, make sure that `poetry install` has been run and the virtual-env is activated by running `poetry shell`. Then execute `pre-commit install` to install the git hook scripts.
+
+   Once it is done, git will ensure formatting, linting, and static typing (via `mypy`) is correct when you perform a commit.
 
 4. Open the project and start debugging / developing via:
 

diff --git a/debug.py b/debug.py
@@ -40,6 +40,7 @@
         err=True,
     )
     args_file.touch(exist_ok=False)
+    args_file.write_text("--version")
 
 commands_sequence = args_file.read_text().splitlines()
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	108	2	98%	83, 98
deploy.py	72	7	90%	44, 46, 92–94, 158, 182
dispenser.py	121	1	99%	77
doctor.py	48	3	94%	142–144
explore.py	50	12	76%	34–39, 41–46
generate.py	67	3	96%	74–75, 140
goal.py	44	1	98%	71
init.py	190	16	92%	277–278, 328, 331–333, 344, 388, 414, 454, 463–465, 468–473, 486
localnet.py	119	15	87%	74–78, 111, 123, 138–148, 161, 206, 227–228
task.py	34	3	91%	25–28
src/algokit/cli/common
utils.py	26	2	92%	120, 123
src/algokit/cli/tasks
analyze.py	81	1	99%	81
assets.py	82	13	84%	65–66, 72, 74–75, 105, 119, 125–126, 132, 134, 136–137
ipfs.py	51	8	84%	52, 80, 92, 94–95, 105–107
mint.py	66	4	94%	48, 70, 91, 250
send_transaction.py	65	10	85%	52–53, 57, 89, 158, 170–174
sign_transaction.py	59	8	86%	21, 28–30, 71–72, 109, 123
transfer.py	39	3	92%	26, 90, 117
utils.py	99	45	55%	26–34, 40–43, 75–76, 100–101, 125–133, 152–162, 209, 258–259, 279–290, 297–299
vanity_address.py	56	10	82%	41, 45–48, 112, 114, 121–123
wallet.py	79	4	95%	21, 66, 136, 162
src/algokit/core
bootstrap.py	117	10	91%	101–102, 124, 151, 180–185
conf.py	54	8	85%	12, 24, 28, 36, 38, 71–73
deploy.py	69	11	84%	61–64, 73–75, 79, 84, 91–93
dispenser.py	202	26	87%	91, 123–124, 141–149, 191–192, 198–200, 218–219, 259–260, 318, 332–334, 345–346, 356, 369, 384
doctor.py	65	7	89%	67–69, 92–94, 134
generate.py	41	2	95%	69, 87
goal.py	60	3	95%	30–31, 41
log_handlers.py	68	7	90%	50–51, 63, 112–116, 125
proc.py	45	1	98%	98
sandbox.py	218	18	92%	62, 73–75, 96, 142–149, 160, 456, 472, 497, 505
typed_client_generation.py	80	5	94%	55–57, 70, 75
utils.py	104	31	70%	44–45, 49–68, 129, 132, 138–152
version_prompt.py	72	8	89%	26–27, 39, 58–61, 79, 108
src/algokit/core/tasks
analyze.py	94	3	97%	106–113, 188
ipfs.py	63	7	89%	58–64, 140, 144, 146, 152
nfd.py	49	13	73%	25, 31, 34–41, 70–72, 99–101
vanity_address.py	90	34	62%	49–50, 54, 59–75, 92–108, 128–131
wallet.py	71	5	93%	37, 129, 155–157
src/algokit/core/tasks/mint
mint.py	78	10	87%	123–133, 187
models.py	90	11	88%	50, 52, 57, 71–74, 85–88
TOTAL	3473	400	88%