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

Adds instructions for installing the latest ppb code. #540

Merged
merged 3 commits into from
Feb 21, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/howto/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,9 @@ How To: The ppb Cookbook
=============================

This section is for direct how tos to solve specific problems with ppb.

.. toctree::
:maxdepth: 2
:caption: Contents:

use-latest
41 changes: 41 additions & 0 deletions docs/howto/use-latest.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
Test Pre-Release Features
===========================================================

Sometimes you want to try the latest features that have been developed for
ppb before they have a formal release on pypi. You have two options: provide
a git uri to the ppb canon branch or use a dev release from test.pypi.org.

With pip Directly
----------------------------------------

To install with pip directly from github, enter the following command into your shell::

pip install git+https://github.com/ppb/pursuedpybear.git

If you want to use the test server for pypi instead::

pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple --pre ppb

With requirements.txt
-----------------------------------------

To install using a requirements.txt file and the current git code, put
``git+https://github.com/ppb/pursuedpybear.git`` as your requirement line
then invoke pip as normal::

pip install -r requirements.txt

To install from test.pypi.org with a requirements file, put the following in
your requirements.txt::

--index-url https://test.pypi.org/simple/
--extra-index-url https://pypi.org/simple
--pre
ppb

These options download ppb from `test.pypi.org`_ and the remaining
dependencies from PyPI as normal.

Now you need to invoke pip as so::

pip install -r requirements.txt