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

docs: quickstart instructions for install from PyPI #602

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

joanise
Copy link
Member

@joanise joanise commented Nov 28, 2024

PR Goal?

On PyPI, like on GH, the quickstart instructions start with checking out EV from GitHub. We should start with PyPI-compatible instructions, then move on to instructions to install from source.

Feedback sought?

Make sure my updated instructions are correct

Priority?

medium

Tests added?

no, but I tested these instructions while writing #600

How to test?

Follow the new instructions and make sure the result is a valid environment.

Confidence?

high

Version change?

no

Related PRs?

no

Right now, `pip install everyvoice` fails because all published versions are
alpha, so the instructions need to be specific for now.
Copy link

Review changes with  SemanticDiff

Copy link
Contributor

github-actions bot commented Nov 28, 2024

CLI load time: 0:00.29
Pull Request HEAD: bff4a6d2b7fe49b296e5a9f4f2b015c628ed2ee9
Imports that take more than 0.1 s:
import time: self [us] | cumulative | imported package
import time:       264 |     110575 |   typer
import time:      6370 |     230585 | everyvoice.cli

Copy link

codecov bot commented Nov 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.59%. Comparing base (e3fe86a) to head (bff4a6d).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #602   +/-   ##
=======================================
  Coverage   76.59%   76.59%           
=======================================
  Files          46       46           
  Lines        3452     3452           
  Branches      470      470           
=======================================
  Hits         2644     2644           
  Misses        706      706           
  Partials      102      102           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@joanise joanise changed the title Dev.ej/pypiquickstart docs: quickstart instructions for install from PyPI Nov 29, 2024
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 this pull request may close these issues.

1 participant