Improve first-time setup workflow

Aperta
#42 0 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
30/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
python
Ambito
build-system, developer-experience

Direzione di ricerca

Start with the make deps flow in Makefile, especially the command-output tasks at lines 211-225, and review the setup guidance in README.md. Compare the documented shell-rc approach with the proposed setup task, then define which approach should eliminate the repeated manual setup steps and how completion will be verified.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

The first-time setup workflow as of initial public release is effectively:

  1. make deps, which will error if Homebrew isn't found.
    1. User must manually make install-homebrew to install Homebrew, then run make deps again
  2. make deps, via deps-brew will install deps from Homebrew including pyenv
  3. make deps, via install-python via deps-py, will install Python from pyenv, which will error if pyenv isn't found
    1. User must manually add pyenv loading code to shell rcfile, then run make deps again
  4. make deps, via install-poetry via deps-py, will install Poetry using pyenv-installed Python or system Python, whichever it detects first, and only if poetry isn't available as of the start of the current run of make.
  5. make deps, via poetry-install via deps-py, will install Python deps using Poetry, which will error if poetry isn't found
    1. User must manually add ~/.local/bin, Poetry's default installation path, to their PATH in shell rcfile, then run make deps again.
  6. Complete 🎉

There are some steps I skipped in here related to telling Poetry which Python to use (it generally just works) and sync'ing Peru (also generally just works).

These one-time setup steps ("user must manually…") are annoying. While some tasks tell the user that they need to read command output, too many users just… don't.

Possible solutions:

  1. Document most generic thing to pre-add to a user's shellrc file in README.md or at the end of make deps.
  2. Create a task make wreck-my-rcfile or maybe more nicely make setup-rcfile-once that modifies the shellrc with what should be put there carefully manually.
  3. No action: let the user suffer having ignored the nudge to read command output.
Lingua principale
Makefile
Stelle
31
Fork
6
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di target/make-python-devex

Tutte le issue di target/make-python-devex

Issue simili

Altre issue su Build System

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.