Update the python setup instructions #442
Conversation
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.
I have tested this simpler setup (as given on the main readme) myself.
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.
Different to the previous commit, for MD code blocks `py` is enough. Also, you hardly ever need a semicolon in python.
|
|
||
| Of course you can replace the command `py` with anything that leads to the python executable of your liking. | ||
| 1. Install [python >=3.12](https://www.python.org/downloads/) | ||
| 2. Run `pip install arctrl` |
There was a problem hiding this comment.
Does the reference to fsspreadsheet work?
There was a problem hiding this comment.
Actually, later I had to do pip install fsspreadsheet because python complained about not finding such a module. But I think it should in fact be possible to stick with a "one-step installation". Pip should be able to handle requirements without the user having to deal with it manually.
There was a problem hiding this comment.
I think the problem here is, that theres not actually a dependency to fsspreadsheet (the python package). So pip can't know this.
There was a problem hiding this comment.
Could a solution be to add "fsspreadsheet" to pyprojec.toml (in the root folder of this project) -> [build-system] -> requires ?
|
|
||
| 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`. |
There was a problem hiding this comment.
This can vary by environment, which would be the more common one?
There was a problem hiding this comment.
Tbh, I never saw a simple py before. If anything, sometimes python3 is/must be used, in my experience.
There was a problem hiding this comment.
Hmm, okay doesn't really matter to me. The developer will hopefully pick the right one for himself.
|
|
||
| ```python |
There was a problem hiding this comment.
Does this make a difference in your markdown editor?
There was a problem hiding this comment.
No but it is shorter. And for this markup purpose I promote the short versions. They are also less ambiguous regarding the spelling. I (and not only I) argue that for both humans and machines language tags like the following are actually easier and better for compatibility: py for Python, js for JavaScript, sh for shell/bash, etc.
|
|
||
| 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 `<class 'arctrl.arc.ARC'>` into the console. | ||
| Verify a correct setup by creating a file `ARCTest.py` (anywhere). Then run `python path/to/ArcTest.py`. This will print `<class 'arctrl.arc.ARC'>` into the console. |
There was a problem hiding this comment.
Agree with the "anywhere" and "python path/to" part. But the first sentence feels a bit off now grammatically. How about "Verify correct setup by creating ARCTest.py file (anywhere).
There was a problem hiding this comment.
Idc tbh :-) The sentence was in bullet point form anyway. Feel free to edit the style as you see fit. Your suggestion is fine by me.
Just minor things. See the commit messages.