From 3a224aff0d69bb72bb5d8dd0cefd686dc2e8d17b Mon Sep 17 00:00:00 2001 From: Nate Prewitt Date: Mon, 30 Jan 2017 21:36:13 -0700 Subject: [PATCH] wording and formatting updates --- docs/advanced.rst | 35 ++++++++++++++++++----------------- docs/index.rst | 1 + 2 files changed, 19 insertions(+), 17 deletions(-) diff --git a/docs/advanced.rst b/docs/advanced.rst index 3c1a019c..6d3fa362 100644 --- a/docs/advanced.rst +++ b/docs/advanced.rst @@ -7,8 +7,8 @@ This document covers some of pipenv's more advanced features. .. _environment_management: -Environment Management ------------------------ +☤ Environment Management +------------------------ The two primary commands you'll use in managing your pipenv environment are ``pipenv install`` and ``pipenv uninstall``. @@ -16,12 +16,12 @@ The two primary commands you'll use in managing your pipenv environment are .. _pipenv_install pipenv install -^^^^^^^^^^^^^^ +////////////// ``pipenv install`` is used for installing packages into the pipenv virtual environment and updating your Pipfile. -Along with the basic install command, which takes parameters in the form:: +Along with the basic install command, which takes the form:: $ pipenv install [package names] @@ -32,26 +32,26 @@ The user can provide these additional parameters: - ``--python`` - Perform the install in a virtualenv using the provided python. .. warning:: None of the above commands should be used together. They are also - *destructive* and will delete your current virtualenv before replacing + **destructive** and will delete your current virtualenv before replacing it with an appropriately versioned one. - - ``--dev`` - Install only packages from [dev-packages] in your ``Pipfile.lock``. + - ``--dev`` - Install both ``develop`` and ``default`` packages from ``Pipfile.lock``. - ``--system`` - Use the system ``pip`` command rather than the one from your virtualenv. - ``--lock`` - Generate a new ``Pipfile.lock`` adding the newly installed packages. .. _pipenv_uninstall pipenv uninstall -^^^^^^^^^^^^^^^^ +//////////////// ``pipenv uninstall`` supports all of the parameters in `pipenv install <#pipenv-install>`_, as well as one additonal, ``--all``. - - ``--all`` - The use of this parameter in an uninstall command will purge all - files from the virtual environment, but leave the Pipfile untouched. + - ``--all`` - This parameter will purge all files from the virtual environment, + but leave the Pipfile untouched. -Testing Projects ----------------- +☤ Testing Projects +------------------ While pipenv is still a relatively new project, it's already being used in projects like `Requests`_. Specifically for transitioning to the new Pipfile @@ -61,7 +61,8 @@ We've currently tested deployments with both `Travis-CI`_ and `tox`_ with succes Travis-CI -^^^^^^^^^ +///////// + An example Travis-CI setup can be found in `Requests`_. The project uses a Makefile to define common functions such as its ``init`` and ``tests`` commands. Here is a stripped down example ``.travis.yml``:: @@ -80,7 +81,7 @@ a stripped down example ``.travis.yml``:: script: - make test -and the correlating Makefile:: +and the corresponding Makefile:: init: pip install pipenv @@ -91,7 +92,8 @@ and the correlating Makefile:: tox -^^^ +/// + Alternatively, you can configure a ``tox.ini`` like the one below for both local and external testing:: @@ -101,15 +103,14 @@ and external testing:: [testenv] deps = pipenv commands= - pipenv install + pipenv install --dev pipenv run py.test tests [testenv:flake8-py3] basepython = python3.4 commands= {[testenv]deps} - pipenv install - pipenv install flake8 + pipenv install --dev pipenv run flake8 --version pipenv run flake8 setup.py docs project test diff --git a/docs/index.rst b/docs/index.rst index 39b9c998..a81cba0b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -125,6 +125,7 @@ Caveats :maxdepth: 2 :caption: Contents: + advanced Indices and tables