Remove conda env file and improve README #753
Conversation
If you can think of a way to do that in text without needing to update it over time (which we're inevitably bound to forget if its decentralized) I'm all for it Otherwise, the attempt to |
| ```shell | ||
| pip install neuroconv | ||
| ``` | ||
|
|
||
| For more flexibility we recommend installing the latest version directly from GitHub. The following commands create an environment with all the required dependencies and the latest updates: | ||
| To install the current unreleased `main` branch (requires `git` to be installed in your environment, such was via `conda install git`), run: |
There was a problem hiding this comment.
I think it would be better to point them to the official instalation instructions of the git project:
https://git-scm.com/downloads
There was a problem hiding this comment.
IDK, that tends to do different things than you would expect depending on the platform. Suggested added both just in case
On windows for instance, it's a standalone interpreter with it's own console (doesn't play well with standard command prompt)
You can technically add it to the system registry but behaves best with conda when installed as a separate package
There was a problem hiding this comment.
Ah I see. Ok, I did not see this before writing my comment below. Ok, so in your experience installing conda with git is the easier for windows users and hence you are making that suggestion.
The current two-fold solution seems fine but we could also explicitly mention that we suggest git on windows. As you feel is better.
README.md
Outdated
| pip install git+https://github.com/catalystneuro/neuroconv.git@main | ||
| ``` | ||
|
|
||
| To install the package in [editable mode](https://pip.pypa.io/en/stable/cli/pip_install/#editable-installs), run: |
There was a problem hiding this comment.
Just for your information.
For another PR as you are just refactoring but I think we probably should remove mentions of editable installs on general readme documents and send them over to the developer sections.
With the migration away from setup tools as a default, editable installs are less and less consistent. I jumped into this rabbit hole last week. Just two point out two common problems:
- Poetry which is one of the most pouplar npm-like experiences for python does not suppport editable installs.
- static analysis tools would not be able to use the enabled editable installs because they use import hooks:
microsoft/pylance-release#3473
I can take care of this later.
There was a problem hiding this comment.
Removed editable install instructions; I believe the idea of this README duplicating our user guide in the docs is to reduce redirection for people just finding the package on PyPI or main GitHub page. So just quickest and dirtiest instructions to get going. Otherwise I'm in greater favor of going the GUIDE README approach and offloading everything of detail to the main docs
There was a problem hiding this comment.
Good. Not sure if they should be removed from the cookie cutter for the conversion projects as well. Here we expect users, there we expect people to change stuff? leaning to remove it as well.
There was a problem hiding this comment.
Conversion projects depend on the client. Some want/need to tamper with stuff, so yes to editable there
Others want static PyPI release with CLI tooling; what we do most with them with respect to bug fixes is do the git based pip install of a particular branch or commit
|
This is OK to me. If no one else is using these files I will trust @CodyCBakerPhD gut that the mainentance is not worth the convenience. |
Some people (ex. python-gitlab) look like they have pypi keep track of it and then link a badge, but tbh it seems like a bit more work than its worth in this case. |
Oooo that is a nice looking actually |
Closes #743
Fixes #742