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

install: reorder methods and add badges #7495

Closed
casperdcl opened this issue Jan 7, 2020 · 21 comments
Closed

install: reorder methods and add badges #7495

casperdcl opened this issue Jan 7, 2020 · 21 comments

Comments

@casperdcl
Copy link
Contributor

casperdcl commented Jan 7, 2020

LATEST UPDATE: Scroll to #7495 (comment).

Update options including order and badges.

  • conda Conda-forge or Conda-forge
  • snap Snapcraft or dvc
    • also Get it from the Snap Store or Get it from the Snap Store
  • pip PyPI-Status
  • GitHub donwloads GitHub release (latest by date)
    • deb
    • pkg
    • rpm
    • exe
  • apt (?)
  • choco Chocolatey Version
  • brew homebrew
  • anything else?

Probably need to split first based on OS:

  • Linux
    • conda
    • snap
    • deb/rpm
    • pip
  • Mac
    • conda
    • brew
    • pip
    • pkg
  • Windows
    • conda
    • choco
    • pip
    • exe
@jorgeorpinel jorgeorpinel changed the title Install options install: update options? Jan 7, 2020
@jorgeorpinel
Copy link
Contributor

Sounds like it's mostly about Windows @casperdcl. Would you like to open a PR directly for this? I think you worked on the snap method, for example.

@casperdcl
Copy link
Contributor Author

I didn't intend it to be only about Win. In my experience there tends to be different ordering & options for Linux/Win/Mac. Could make a PR but probably needs discussion first from users of different OSs how they prefer/recommend installing (was discussing with @shcheklein...)

@shcheklein
Copy link
Member

something else include "binary" pyinstaller packages - pkg on Mac, exe on Windows.

I think we can do something like:

Linux:

conda
snap
apt
pip

Mac:

conda
brew
pip
pkg

Windows:

conda
choco
pip
exe

@casperdcl I'm not sure about conda vs brew/snap, for example. How common is it to install things with conda globally? (I know for example it's better not to do this with pip).

@jorgeorpinel jorgeorpinel changed the title install: update options? install: update methods? Jan 7, 2020
@jorgeorpinel
Copy link
Contributor

probably needs discussion first

It may be worth it to review past issues related to this, as we recently completely rewrote the installation section. e.g. iterative/dvc.org#701/#734, iterative/dvc.org#660/#701/#734, iterative/dvc.org#656/#695, others?

else include "binary" pyinstaller packages

Related: iterative/dvc.org#65 (That's an old one!)

@casperdcl
Copy link
Contributor Author

I think there are 2 major categories to split up: OS and end-user proficiency. Casual users can't be expected to go through the lengthy "separate conda env with dvc script appended to global $PATH" I posted elsewhere. Actually I'd say casual users should stick to snap/choco/brew. Advanced users meanwhile probably don't need much guidance - they just need to be aware what packages exist.

@shcheklein
Copy link
Member

@casperdcl sounds good.

Advanced users meanwhile probably don't need much guidance

It seems an obvious though, but my recent experience makes me think differently a bit. And probably, the reason for this that being even an advanced CLI user does not make you immediately an expert in different ways to install things or different environments.

Probably they do not fit then into your meaning of advanced though, right? :) and should stick with some default choice.

@casperdcl
Copy link
Contributor Author

Probably they do not fit then into your meaning of advanced though, right? :) and should stick with some default choice.

Indeed. In this context I was using "advanced" to refer to knowledge of their preferred installation mechanism.

@jorgeorpinel
Copy link
Contributor

Shall we include snap here too and close iterative/dvc.org#918? Cc @casperdcl please notice that other issue's desc:

as we discussed, could you please add this method to the docs as snap is official now?

@casperdcl
Copy link
Contributor Author

for the record this issue is about documenting a new option reordering options while iterative/dvc.org#918 is about reordering options documenting a new option (vis iterative/dvc.org#918 (comment)).

@jorgeorpinel
Copy link
Contributor

I think you meant this one is about reordering and iterative/dvc.org#918 about a new option @casperdcl.

@jorgeorpinel jorgeorpinel changed the title install: update methods? install: reorder methods? Jan 20, 2020
@fabiosantoscode
Copy link
Contributor

Don't forget brew works on linux!

@casperdcl
Copy link
Contributor Author

also potentially badges (vis iterative/dvc.org#918 (comment)). Added to description here...

@jorgeorpinel jorgeorpinel changed the title install: reorder methods? install: reorder methods and add badges? Jan 24, 2020
casperdcl referenced this issue in casperdcl/dvc Feb 21, 2020
Add |Choco|
Add |Brew|
Fix style for |Conda|
Add |PyPI|
Add |Packages|
Fixes iterative#3233
Related https://github.com/iterative/dvc.org/issues/904
@casperdcl casperdcl mentioned this issue Feb 21, 2020
7 tasks
efiop referenced this issue Feb 27, 2020
* docs: add and update badges

Add |Choco|
Add |Brew|
Fix style for |Conda|
Add |PyPI|
Add |Packages|
Fixes #3233
Related https://github.com/iterative/dvc.org/issues/904

* docs: add badge logos

* docs: minor badge tidy

* docs: add choco install, add OS, update order
@jorgeorpinel jorgeorpinel changed the title install: reorder methods and add badges? install: reorder methods and add badges Apr 4, 2020
@jorgeorpinel
Copy link
Contributor

Windows:
conda
choco
pip
exe

Why is conda on top? choco is probably the easiest from cmd line for most cases, no?

@shcheklein
Copy link
Member

@jorgeorpinel it's a good question. I don't know how popular choco is to be honest ... it's as popular as brew for example?

@casperdcl
Copy link
Contributor Author

I think maybe conda was on top for consistency across all platforms but I agree we should probably change to conda as second for all.

@jorgeorpinel
Copy link
Contributor

it's as popular as brew

My impression is that it's the equivalent to brew, yes. But much fewer people work on command line in Windows just because (developers mainly, I guess, same as in Mac but there's less).

Probably more people use Anaconda Prompt because it's such a popular DS Python disto. But then again Git Bash is probably also quite popular (comes included in a bunch of other tools like Cmder or Git for Windows), and choco would be a better fit in those cases... so yeah not sure.

For now I put choco on top in iterative/dvc.org#1195

@jorgeorpinel
Copy link
Contributor

I believe we did take care of this from seeing https://dvc.org/doc/install

@jorgeorpinel
Copy link
Contributor

p.s. well except for the badges but do we want those in docs? Maybe in the README

@jorgeorpinel
Copy link
Contributor

p.p.s. and the badges do exist in the README now. But the order there is not the same as in docs. Do you think we should reopen this and move it to the core repo @casperdcl ?

@casperdcl
Copy link
Contributor Author

probably could be moved to core - would be a first iteration on updating somewhat neglected readmes.

https://github.com/iterative/terraform-provider-iterative/#readme just got an overhaul (iterative/terraform-provider-iterative#433) for reference/review :)

@jorgeorpinel jorgeorpinel reopened this Mar 23, 2022
@jorgeorpinel jorgeorpinel transferred this issue from iterative/dvc.org Mar 23, 2022
@efiop
Copy link
Contributor

efiop commented Dec 8, 2023

closing as stale

@efiop efiop closed this as completed Dec 8, 2023
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

No branches or pull requests

6 participants