[Notes] [Git][BuildStream/buildstream][chandan/pip-install-instructions] doc: Add instructions to install BuildStream via PyPI

[Chandan Singh <gitlab mg gitlab com>]

Title: GitLab

Chandan Singh pushed to branch chandan/pip-install-instructions at BuildStream / buildstream

Commits:

• 93671320
  by Chandan Singh at 2018-08-23T22:32:20Z

  doc: Add instructions to install BuildStream via PyPI
  
  Add instructions to install and update BuildStream python package via
  PyPI, and also make it the recommended method.
  
  Part of https://gitlab.com/BuildStream/buildstream/issues/587.
  

1 changed file:

• doc/source/install_linux_distro.rst

Changes:

doc/source/install_linux_distro.rst

---

...	...	@@ -152,8 +152,24 @@ for advice on this.
152	152
153	153	Installing
154	154	~~~~~~~~~~
155		-Once you have the base system dependencies, you can clone the BuildStream
156		-git repository and install it as a regular user::
	155	+Once you have the base system dependencies, you can install the BuildStream
	156	+python package as a regular user.
	157	+
	158	+Via PyPi (recommended)
	159	+++++++++++++++++++++++
	160	+::
	161	+
	162	+ pip3 install --user BuildStream
	163	+
	164	+This will install latest stable version of BuildStream and its pure python
	165	+dependencies into your user's homedir in ``~/.local``.
	166	+
	167	+Keep following the instructions below to ensure that the ``bst``
	168	+command is in your ``PATH`` and to enable bash completions for it.
	169	+
	170	+Via Git checkout
	171	+++++++++++++++++
	172	+::
157	173
158	174	git clone https://gitlab.com/BuildStream/buildstream.git
159	175	cd buildstream
...	...	@@ -206,9 +222,19 @@ to your ``~/.bash_completion``:
206	222
207	223	Upgrading BuildStream
208	224	~~~~~~~~~~~~~~~~~~~~~
209		-Assuming you have followed the default instructions above, all
210		-you need to do to upgrade BuildStream is to update your local git
211		-checkout::
	225	+
	226	+Via PyPi
	227	+++++++++
	228	+
	229	+If you installed BuildStream from PyPi, you can update it like so::
	230	+
	231	+ pip install --user --upgrade BuildStream
	232	+
	233	+Via Git checkout
	234	+++++++++++++++++
	235	+
	236	+If you installed BuildStream from a local git checkout using ``-e`` option, all
	237	+you need to do to upgrade BuildStream is to update your local git checkout::
212	238
213	239	cd /path/to/buildstream
214	240	git pull --rebase

—
View it on GitLab.
You're receiving this email because of your account on gitlab.com. If you'd like to receive fewer emails, you can adjust your notification settings.