[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:

• b97c6ded
  by Chandan Singh at 2018-08-23T22:44:10Z

  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,29 @@ 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	+.. note::
	171	+
	172	+ If you want a specific version of BuildStream, you can install it using
	173	+ ``pip install --user BuildStream==<version-number>``
	174	+
	175	+Via Git checkout
	176	+++++++++++++++++
	177	+::
157	178
158	179	git clone https://gitlab.com/BuildStream/buildstream.git
159	180	cd buildstream
...	...	@@ -206,9 +227,19 @@ to your ``~/.bash_completion``:
206	227
207	228	Upgrading BuildStream
208	229	~~~~~~~~~~~~~~~~~~~~~
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::
	230	+
	231	+Via PyPI
	232	+++++++++
	233	+
	234	+If you installed BuildStream from PyPI, you can update it like so::
	235	+
	236	+ pip install --user --upgrade BuildStream
	237	+
	238	+Via Git checkout
	239	+++++++++++++++++
	240	+
	241	+If you installed BuildStream from a local git checkout using ``-e`` option, all
	242	+you need to do to upgrade BuildStream is to update your local git checkout::
212	243
213	244	cd /path/to/buildstream
214	245	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.