fix instructions for testing installation with TestPyPI in packages tutorial

Open Beginner friendly
#68 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Find the packages tutorial section containing the TestPyPI installation command. Update the instructions to use both PyPI and TestPyPI as described in the issue, then verify the rendered tutorial shows the corrected command and explains that dependencies may remain on PyPI.

Written by the indexing model from the issue text.

Description

The current instructions say to run pip install -i https://testpypi.python.org/pypi PACKAGENAME, which is what TestPyPI says to do as well. However, this fails if any dependencies of your package are not on TestPyPI, but only on PyPI.

You can look for dependencies on both regular PyPI and TestPyPI using
pip install PACKAGENAME --extra-index-url=https://test.pypi.org/simple/

Dominant language
Jupyter Notebook
Stars
17
Forks
4
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ContextLab/CDL-tutorials

All issues in ContextLab/CDL-tutorials

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.