Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding a 'Beginner Friendly CLI" version of the Getting Started Guide #5259

Open
skylarposler opened this issue May 25, 2024 Discussed in #5258 · 8 comments · May be fixed by #5295
Open

Adding a 'Beginner Friendly CLI" version of the Getting Started Guide #5259

skylarposler opened this issue May 25, 2024 Discussed in #5258 · 8 comments · May be fixed by #5295

Comments

@skylarposler
Copy link

skylarposler commented May 25, 2024

Discussed in #5258

Originally posted by skylarposler May 24, 2024
Proposal:
Creating a ‘Beginner Friendly CLI Getting Started Guide’ with more in-depth step by step instructions and screenshots to help eliminate errors upon installation and configuration, will help more inexperienced CLI users navigate and set up beets correctly.

Result:
To make beets more available to beginner CLI users.

@khrystianc
Copy link

If no one has started or done this, I would like to work on a product for this issue resolution.

@skylarposler
Copy link
Author

Hi! I'm currently working on the windows version of this. If you would like, the MacOS could benefit from this as well.

@khrystianc
Copy link

Thank you for getting back to me so quickly. This issue is all yours. I am working under windows as well.

@RollingStar
Copy link
Collaborator

Thank you! I just gave it a very light skim but being accessible to non-command-line users should help our reach tremendously.

I can't find where I suggested it, but I think "editable" (running from python source .py files) should be our default/preferred/only way of running beets in the documentation.

https://beets.readthedocs.io/en/stable/faq.html#run-the-latest-source-version-of-beets

It encourages new users to become new developers of light features/bug fixes, and encourages understanding how beets works.

@justinmayer
Copy link
Contributor

I am not sure that “editable” Python installation should be presented in the documentation as the default/preferred way of running Beets. But I am definitely sure that it shouldn’t be presented as the only way.

For folks who want to contribute to Beets, I think it's great to encourage them to run the latest version in editable mode. Many people do not fall in that category, and those users are arguably better served by packaged, stable releases.

Plus, that section of the documentation needs work before it could even be used to encourage folks to run in editable mode. For starters, setup.py does not exist any longer, so the suggested python setup.py install option will fail.

Perhaps most importantly, it is not clear from those docs how to install Beets in editable mode and install optional packages. For example, how would someone install Beets in editable mode with the following optional packages? This section of the documentation does not cover this at all.

python -m pip install beets[chroma,discogs,fetchart,lastgenre,lyrics,mpdstats,plexupdate,web]

Editable mode is awesome, and I use it all the time for projects that I maintain. But it is often not the best installation option for end users, and frequently becomes a crutch for projects that often go way, way too long between packaged releases. (Ahem.)

@antebudimir
Copy link

Hi!

Has there been any progress on this one?

@justinmayer
Copy link
Contributor

@antebudimir: Please allow me to refer you to Any Updates?

@antebudimir
Copy link

Yeah, that does and doesn't make sense because it happened not once that I stumbled upon a repo that didn't follow this logic and there actually was something happening in the meantime that wasn't put to paper. 😉

Thanks either way.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants