From e8536cae0842fdbf12c9b46b5ddfbdcba52f88fb Mon Sep 17 00:00:00 2001 From: Christopher Kappe Date: Tue, 17 Sep 2024 14:29:33 +0200 Subject: [PATCH 1/4] Change python version specification What was `>3.11.x` even supposed to mean? I think greater than *or equal* is more straightforward than this formulation with some variable x. --- docs/GettingStarted.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/GettingStarted.md b/docs/GettingStarted.md index ba7b0ed7..d73ec0d6 100644 --- a/docs/GettingStarted.md +++ b/docs/GettingStarted.md @@ -75,7 +75,7 @@ console.log(ARC) // [class ARC] ## Setup - Python -1. Install [python >3.11.x](https://www.python.org/downloads/) +1. Install [python >=3.12](https://www.python.org/downloads/) 2. Create folder and put an `requirements.txt` file inside. 3. Write `arctrl` and `fsspreadsheet` in two separate lines into it ``` From 76bb753d3d92cfc77e3e4b3ba100bcbf63286840 Mon Sep 17 00:00:00 2001 From: Christopher Kappe Date: Tue, 17 Sep 2024 14:31:03 +0200 Subject: [PATCH 2/4] Update python setup instructions I have tested this simpler setup (as given on the main readme) myself. --- docs/GettingStarted.md | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/docs/GettingStarted.md b/docs/GettingStarted.md index d73ec0d6..46d86edf 100644 --- a/docs/GettingStarted.md +++ b/docs/GettingStarted.md @@ -76,13 +76,7 @@ console.log(ARC) // [class ARC] ## Setup - Python 1. Install [python >=3.12](https://www.python.org/downloads/) -2. Create folder and put an `requirements.txt` file inside. -3. Write `arctrl` and `fsspreadsheet` in two separate lines into it - ``` - arctrl - fsspreadsheet - ``` -4. run `py -m pip install -r requirements.txt` +2. Run `pip install arctrl` Of course you can replace the command `py` with anything that leads to the python executable of your liking. From 8138ad4c95bfefa0eeea707c678915fe12a2d625 Mon Sep 17 00:00:00 2001 From: Christopher Kappe Date: Tue, 17 Sep 2024 14:32:21 +0200 Subject: [PATCH 3/4] Change the command `py` to `python` I know at least three Linux distributions where `py` is not available by default. If someone knows how to set up the shorter alias or symbolic link, they know that they can use it here. The longer command in our examples may lead to fewer frustrated users. --- docs/GettingStarted.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/GettingStarted.md b/docs/GettingStarted.md index 46d86edf..f044db56 100644 --- a/docs/GettingStarted.md +++ b/docs/GettingStarted.md @@ -78,13 +78,11 @@ console.log(ARC) // [class ARC] 1. Install [python >=3.12](https://www.python.org/downloads/) 2. Run `pip install arctrl` - Of course you can replace the command `py` with anything that leads to the python executable of your liking. - Thats it! 🎉 -You can now reference ARCtrl in any `.py` file and run it with `py path/to/Any.py`. +You can now reference ARCtrl in any `.py` file and run it with `python path/to/Any.py`. -Verify correct setup by creating `ARCTest.py` file with the content from below in the same folder, which contains your `requirements.txt`. Then run `py ./ArcTest.py`. This will print `` into the console. +Verify correct setup by creating `ARCTest.py` file with the content from below in the same folder, which contains your `requirements.txt`. Then run `python ./ArcTest.py`. This will print `` into the console. ```python # ARCTest.py From 25d3d2bf3ad135d6e4ce8a4bcdbc5a6564f38b6a Mon Sep 17 00:00:00 2001 From: Christopher Kappe Date: Tue, 17 Sep 2024 14:35:43 +0200 Subject: [PATCH 4/4] Update the test instructions Different to the previous commit, for MD code blocks `py` is enough. Also, you hardly ever need a semicolon in python. --- docs/GettingStarted.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/GettingStarted.md b/docs/GettingStarted.md index f044db56..ba58f82b 100644 --- a/docs/GettingStarted.md +++ b/docs/GettingStarted.md @@ -82,11 +82,11 @@ Thats it! 🎉 You can now reference ARCtrl in any `.py` file and run it with `python path/to/Any.py`. -Verify correct setup by creating `ARCTest.py` file with the content from below in the same folder, which contains your `requirements.txt`. Then run `python ./ArcTest.py`. This will print `` into the console. +Verify a correct setup by creating a file `ARCTest.py` (anywhere). Then run `python path/to/ArcTest.py`. This will print `` into the console. -```python +```py # ARCTest.py -from arctrl.arctrl import ARC; +from arctrl.arctrl import ARC print(ARC) # ```