diff --git a/README.rst b/README.rst index 5c72631..88489bb 100644 --- a/README.rst +++ b/README.rst @@ -23,6 +23,8 @@ For questions, issues or general curiosity visit the repo at `https://github.com Installation ------------ +For details on require system packages, see `Full Installation `_. + By default the ``steam`` package doesn't install all dependecies. Add ``[client]`` extra if you are going to use ``SteamClient``. diff --git a/docs/index.rst b/docs/index.rst index 2002483..ef8b1ce 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -12,6 +12,7 @@ Table of Contents .. toctree:: :maxdepth: 3 + install user_guide .. toctree:: diff --git a/docs/install.rst b/docs/install.rst new file mode 100644 index 0000000..55e44c8 --- /dev/null +++ b/docs/install.rst @@ -0,0 +1,75 @@ +Full Installation +================= + +Linux +----- + +Steps assume that ``python`` and ``pip`` are already installed. + +1. Install dependencies (see sections below) +2. Run ``pip install steam[client]`` + +.. note:: + Consider using `virtualenv `_ + in order to keep you system packages untouched. + + +Ubuntu/Debian +^^^^^^^^^^^^^ + +Replace ``python-dev`` with ``python3-dev`` for Python 3. + +.. code-block:: console + + $ sudo apt-get install build-essential libssl-dev libffi-dev python-dev + +RHEL-based +^^^^^^^^^^ + +.. code-block:: console + + $ sudo yum install gcc libffi-devel python-devel openssl-devel + + +Windows +------- + +Cygwin +^^^^^^ + +1. Download cygwin installer from https://cygwin.com/install.html + +2. During the setup select these additional packages + - ``python3`` + - ``python3-devel`` + - ``python3-setuptools`` + - ``gcc-core`` + - ``gcc-g++`` + - ``libffi6`` + - ``libffi-devel`` + - ``openssl-devel`` + +4. Install pip + - Open cygwin terminal + - Run ``easy_install-3.4 pip`` + +3. Run ``pip install steam[client]`` + +.. note:: + Consider using `virtualenv `_ + in order to keep you system packages untouched. + +.. note:: + Installation may take a while as a number of dependecies will be compiled + + +Native Python +^^^^^^^^^^^^^ + +1. Download & install python 3.5 from https://www.python.org/downloads/windows/ + +.. note:: + Installing for all users will require administrator rights + +2. Then from ``cmd`` run ``pip install steam[client]`` + diff --git a/docs/intro.rst b/docs/intro.rst index 4a1b3ab..029affc 100644 --- a/docs/intro.rst +++ b/docs/intro.rst @@ -24,8 +24,10 @@ Checkout the :doc:`user_guide` for examples, or the :doc:`api/index` for details For questions, issues, or general curiosity, visit the repo at `https://github.com/ValvePython/steam `_. -Installation -============ +Quick install +============= + +For details on require system packages, see :doc:`install`. By default the ``steam`` package doesn't install all dependencies. Add ``[client]`` extra if you are going to use :class:`SteamClient `.