From 91f315ceb09343caf2ba747df682aa7f14e48f04 Mon Sep 17 00:00:00 2001
From: Roger Binns <rogerb@rogerbinns.com>
Date: Sun, 12 Jun 2016 19:57:43 -0700
Subject: [PATCH] Document a long pip command

Fixes #217
---
 doc/changes.rst    |  2 ++
 doc/download.rst   | 47 ++++++++++++++++++++++++++++++++--------------
 tools/docupdate.py | 18 ++++++++++++++++--
 3 files changed, 51 insertions(+), 16 deletions(-)

diff --git a/doc/changes.rst b/doc/changes.rst
index 73885cf6..816bd70e 100644
--- a/doc/changes.rst
+++ b/doc/changes.rst
@@ -7,6 +7,8 @@ Change History
 
 Added SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION constant.
 
+Added a :ref:`pip command line <really_want_pip>` in the :doc:`download` page.
+
 3.12.2-r1
 =========
 
diff --git a/doc/download.rst b/doc/download.rst
index aafb3322..0e63d60d 100644
--- a/doc/download.rst
+++ b/doc/download.rst
@@ -144,17 +144,36 @@ https://github.com/rogerbinns/apsw
 easy_install/pip/pypi
 =====================
 
-APSW is **not** available at the Python Package Index (pypi) and hence
-cannot be installed using easy_install, pip or similar tools.  The
-reason for this is that the tools do not provide a way of providing
-options to the setup.py included with APSW and hence there is no way
-for APSW to know if you want SQLite downloaded, a consistent version
-of SQLite or the latest, to use a system SQLite instead, error if an a
-system version is not available etc.  I could pick a sensible default
-but everyone else using pypi would be disadvantaged or worse get
-undesired behaviour (eg different versions of SQLite depending on when
-a machine did an install).  Additionally the world of Python packaging
-is going through another series of changes (distutils2 aka packaging)
-so some solution may come out of that.
-
-I'm happy to work with anyone who has a solution to this problem.
\ No newline at end of file
+APSW is **not** available at the Python Package Index (pypi) and hence cannot be
+installed from it.  (A random person has put an outdated poor quality upload
+under the APSW name.  It has nothing useful to do with this project.) The reason
+for this is that the tools do not provide a way of providing options to the
+setup.py included with APSW and hence there is no way for APSW to know if you
+want SQLite downloaded, a consistent version of SQLite or the latest, to use a
+system SQLite instead, error if an a system version is not available etc.  I
+could pick a sensible default but everyone else using pypi would be
+disadvantaged or worse get undesired behaviour (eg different versions of SQLite
+depending on when a machine did an install).  Additionally the world of Python
+packaging is going through another series of changes (distutils2 aka packaging)
+so some solution may come out of that. I'm happy to work with anyone who has a
+solution to this problem.
+
+.. _really_want_pip:
+I really want to use pip
+------------------------
+
+The following pip command line downloads APSW from github, SQLite from the
+official site, and builds/installs with all extensions enabled.
+
+
+
+
+.. pip-begin
+
+Use this (all one command)::
+
+    pip install --user https://github.com/rogerbinns/apsw/releases/download/3.13.0-r1/apsw-3.13.0-r1.zip \
+    --global-option=fetch --global-option=--version --global-option=3.13.0 --global-option=--all \
+    --global-option=build --global-option=--enable-all-extensions
+
+.. pip-end
\ No newline at end of file
diff --git a/tools/docupdate.py b/tools/docupdate.py
index 5193a652..b6f7c51b 100644
--- a/tools/docupdate.py
+++ b/tools/docupdate.py
@@ -12,6 +12,17 @@
 version=sys.argv[1]
 url="  <https://github.com/rogerbinns/apsw/releases/download/"+version+"/%s>`__"
 
+pip_template="""
+.. pip-begin
+
+Use this (all one command)::
+
+    pip install --user https://github.com/rogerbinns/apsw/releases/download/%s/apsw-%s.zip \\
+    --global-option=fetch --global-option=--version --global-option=%s --global-option=--all \\
+    --global-option=build --global-option=--enable-all-extensions
+""" % (version, version, version.split("-")[0])
+
+
 download=open("doc/download.rst", "rtU").read()
 
 op=[]
@@ -38,9 +49,12 @@
         op.append(url % ("apsw-%s-sigs.zip" % version))
         op.append("  GPG signatures for all files")
         op.append("")
-
         continue
-    if line==".. downloads-end":
+    if line==".. pip-begin":
+        op.extend(pip_template.split("\n"))
+        incomment=True
+        continue
+    if line==".. downloads-end" or line==".. pip-end":
         incomment=False
     if incomment:
         continue