Skip to content

Latest commit

 

History

History
158 lines (102 loc) · 4.82 KB

installation.rst

File metadata and controls

158 lines (102 loc) · 4.82 KB
Raw

Install

Conan can be installed in many Operating Systems. It is extensively used and tested in Windows, Linux (different distros), OSX, and also actively used in FreeBSD and Solaris SunOS, but it has been reported to work in other systems too.

There are three ways to install conan:

  1. The preferred and strongly recommended way to install conan is from PyPI, the Python Package Index, with the pip command.
  2. There are other available installers for different systems, which might come with a bundled python interpreter, so it is not necessary to install python first. Please note that some of these installers might have some limitations, specially those created with pyinstaller (like Windows exe & Linux deb).
  3. Running conan from sources.

Install with pip (recommended)

You need a python 2.7 or 3.X distribution installed in your machine. Modern python distros come with pip pre-installed, if not, install pip following pip docs.

Install conan:

$ pip install conan

Important

Please READ carefully

  • Make sure that your pip installation matches your python (2.7 or 3.X) one.
  • In Linux if you want to install it globally, you might need sudo permissions.
  • We strongly recommend using virtualenvs (virtualenvwrapper works great) for everything python related
  • In Windows and with Python 2.7, you might need to use 32bits python distribution (which is the Windows default one), instead of 64bits.
  • In OSX, specially latest versions that might have System Integrity Protection, pip might fail. Try with virtualenvs, or install with other user $ pip install --user conan.
  • If you are in Windows, and using python <3.5, you might have problems if python is installed in a path with spaces, like "C:/Program Files(x86)/Python". This is a known python limitation, not conan. Install python in a path without spaces, use a virtualenv in another location or upgrade your python installation.
  • In some Linux distros, like Linux Mint, it is possible that you need a restart (shell restart, or logout/system if not enough) after installation, so conan is found in the path.

Install from brew (OSX)

There is a brew recipe, so in OSX, you can install conan with

$ brew update
$ brew install conan

Install from AUR (Arch Linux)

You can find the package here. The easiest way is using pacaur tool:

$ pacaur -S conan

Or you can also use makepkg and install it following the AUR docs: installing packages.

Just remember to install four conan dependencies first. They are not in the official repositories but there are in AUR repository too:

  • python-patch
  • python-node-semver
  • python-distro
  • python-pluginbase

Install the binaries

Go to the conan website and download the installer for your platform!

Execute the installer. You don't need to install python.

Note

You can also use the latest version's links to download the latest installer:

http://downloads.conan.io/latest_debian
http://downloads.conan.io/latest_windows

Initial configuration

Let's check if conan is correctly installed. Execute in your console:

$ conan

You will see something similar to:

Consumer commands
  install    Installs the requirements specified in a conanfile (.py or .txt).
  config     Manages configuration. Edits the conan.conf or installs config files.
  get        Gets a file or list a directory of a given reference or package.
  info       Gets information about the dependency graph of a recipe.
  ...

Install from source

You can run conan directly from source code. First you need to install Python 2.7 or Python 3 and pip.

Clone (or download and unzip) the git repository and install its requirements:

$ git clone https://github.com/conan-io/conan.git
$ cd conan
$ pip install -r conans/requirements.txt

Create a script to execute conan and add it to your PATH.

#!/usr/bin/env python

import sys

conan_repo_path = "/home/your_user/conan" # ABSOLUTE PATH TO CONAN REPOSITORY FOLDER

sys.path.append(conan_repo_path)
from conans.client.command import main
main(sys.argv[1:])

Test your conan script.

$ conan

You should see the conan commands help.