Skip to content

Latest commit

 

History

History
162 lines (107 loc) · 6.41 KB

installation.rst

File metadata and controls

162 lines (107 loc) · 6.41 KB
Raw

Install

Conan can be installed in many Operating Systems. It has been extensively used and tested in Windows, Linux (different distros), OSX, and is also actively used in FreeBSD and Solaris SunOS. There are also several additional operating systems on which it has been reported to work.

There are three ways to install Conan:

  1. The preferred and strongly recommended way to install Conan is from PyPI, the Python Package Index, using the pip command.
  2. There are other available installers for different systems, which might come with a bundled python interpreter, so that you don't have to install python first. Note that some of these installers might have some limitations, specially those created with pyinstaller (such as Windows exe & Linux deb).
  3. Running Conan from sources.

Install with pip (recommended)

To install Conan using pip, you need Python 2.7 or 3.X distribution installed on your machine. Modern Python distros come with pip pre-installed. However, if necessary you can install pip by following the instructions in pip docs.

Warning

Python 2 will soon be deprecated by the Python maintainers. It is strongly recommended to use Python 3 with Conan, especially if need to manage non-ascii filenames or file contents. Conan still supports Python 2, however some of the dependencies have started to be supported only by Python 3. See python2 deprecation notice for details.

Install Conan:

$ pip install conan

Important

Please READ carefully

  • Make sure that your pip installation matches your Python (2.7 or 3.X) version.
  • In Linux, you may need sudo permissions to install Conan globally.
  • We strongly recommend using virtualenvs (virtualenvwrapper works great) for everything related to Python.
  • In Windows and Python 2.7, you may need to use 32bit python distribution (which is the Windows default), instead of 64 bit.
  • In OSX, especially the latest versions that may have System Integrity Protection, pip may fail. Try using virtualenvs, or install with another user $ pip install --user conan.
  • If you are using Windows and Python <3.5, you may have issues if Python is installed in a path with spaces, such as "C:/Program Files(x86)/Python". This is a known Python limitation, and is not related to Conan. Try installing Python in a path without spaces, use a virtualenv in another location or upgrade your Python installation.
  • Some Linux distros, such as Linux Mint, require a restart (shell restart, or logout/system if not enough) after installation, so Conan is found in the path.
  • Windows, Python 3 installation can fail installing the wrapt dependency because of a bug in pip. Information about this issue and workarounds is available here: GrahamDumpleton/wrapt#112.
  • Conan works with Python 2.7, but not all features are available when not using Python 3.x starting with version 1.6

Install from brew (OSX)

There is a brew recipe, so in OSX, you can install Conan as follows:

$ brew update
$ brew install conan

Install from AUR (Arch Linux)

The easiest way to install Conan on Arch Linux is by using one of the Arch User Repository (AUR) helpers, e.g., yay, aurman, or pakku. For example, the following command installs Conan using yay:

$ yay -S conan

Alternatively, build and install Conan manually using makepkg and pacman as described in the Arch Wiki. Conan build files can be downloaded from AUR: https://aur.archlinux.org/packages/conan/. Make sure to first install the three Conan dependencies which are also found in AUR:

  • python-patch
  • python-node-semver
  • 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.

Initial configuration

Check if Conan is installed correctly. Run the following command in your console:

$ conan

The response should be 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 run 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.

Python 2 Deprecation Notice

Before 1.6, all Conan features are fully supported in both Python2 and Python3. For Conan 1.6 and beyond, all features built prior to 1.6 will continue to be fully tested in Python 2 and Python3 moving forward, and the 'default' expectation will be to test new features in both Python 2 and Python 3. However, where a new feature wishes to make use of a feature available in Python 3 or more easily available in Python 3, those features will be implemented and tested only in Python 3, and versions of Conan using Python 2 will not have access to that feature. Such features will be clearly documented in code and documentation.

If and when Conan 2.x is released (Not expected in 2018) the level of compatibility with Python 2 may be reduced further.