Skip to content

Latest commit

 

History

History
74 lines (57 loc) · 2.78 KB

A_Setup_and_install.md

File metadata and controls

74 lines (57 loc) · 2.78 KB

Install and setup the required software on your machine

This guide describes the necessary steps to make your machine ready for using Python and connecting to the B2SHARE service.

Prerequisites

You need a machine equipped with an internet connection and a recent version of the Python software package (version >= 3.4) and the Package Installer for Python (pip) which is installed with the newest versions of Python. If not, see below.

Please make sure your system is up-to-date and has installed the latest security updates.

Python

Depending on the operating system you are using, Python can be installed by either downloading it from the official Python website, or using a package manager (non-Windows only). For Linux-typed systems, a package manager comes pre-installed, for OS X, it needs to be downloaded.

You can check whether you have Python installed by entering the following command:

python --version

If you get a proper response with a version number, you have Python installed on your machine.

Linux

For example, to install Python on Ubuntu, do the following:

apt-get install python

OS X

For OS X, use the package manager Brew. It can be downloaded through the website or directly by the following command:

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

Then install Python using this package manager:

brew install python

Windows

For Windows-enabled machines, go to the Python download page. Download the 3.x version and install it.

The Pip Installs Packages (pip) package installer

Python comes with a great bundle of functionality and can be extended by installing Python packages. You can install Python packages by using the Pip Installs Packages (pip) tool.

Please check whether pip is installed on your system by issuing the following command:

pip --version

If you don't get a proper response with a version number, pip is not installed and you need to install it by following this guide. The quick route is to get the install script directory and execute it using Python:

wget https://bootstrap.pypa.io/get-pip.py
python get-pip.py

If pip was already installed, please make it up-to-date by the following command:

pip install --upgrade pip

Packages

Once Python and pip are installed on your machine, a package needs to be installed in order to get access to the B2SHARE service.

The following packages are required:

jsonpatch
requests
simplejson

Use pip to install it:

pip install jsonpatch requests simplejson

Machine setup

No additional setup is required in order to run Python or the provided script snippets.