Conan Package Manager Documentation

To run Conan from source on Windows, MacOS, or Linux, follow these steps:

1. Ensure pip is installed.
2. Clone the repository into a directory named conan-io (to avoid naming conflicts with the conan command itself).
3. Install the package in editable mode.

Note for Linux users: If your distribution prevents installing Python packages in editable mode in the root Python installation, you must create a Python virtual environment (venv) first.

Conan uses pytest for its test suite. You can run the full suite, specific tests, or tests filtered by markers (like Artifactory readiness).

Prerequisites:

• Specific tool versions are required (e.g., cmake>=3.15).
• The test suite configures tools like CMake and Ninja via conftest.py.

Before running the Conan test suite, you must install the necessary Python requirements and configure your PYTHONPATH environment variable.

Requirements Installation: Install the following requirement files using pip (use sudo on Linux if not using a virtual environment):

• conans/requirements.txt
• conans/requirements_server.txt
• conans/requirements_dev.txt

Environment Configuration: Set the PYTHONPATH to include the current working directory so the tests can locate the Conan modules.

# Install requirements
$ python -m pip install -r conans/requirements.txt
$ python -m pip install -r conans/requirements_server.txt
$ python -m pip install -r conans/requirements_dev.txt

# Set PYTHONPATH (Linux/MacOS)
$ export PYTHONPATH=$PYTHONPATH:$(pwd)

# Set PYTHONPATH (Windows)
$ set PYTHONPATH=.

You can perform batch removals using either a package query or a pre-defined package list file.

Using a Package Query: When using -p or --package-query, you can filter which binaries are removed based on settings or options. Note that if you use a query, the pattern must match packages.

Using a List File: Provide a file via -l or --list containing the packages to be removed.

Constraints:

• You cannot define both a pattern and a --list file in the same command.
• You cannot define both --package-query and a --list file in the same command.
• --lru cannot be used with a --list file or when targeting a remote.

When running Conan audit commands, you can specify different output formats for the vulnerability report. The available formats are:

• Text (Default): A human-readable, colorized terminal output showing package references, vulnerability counts, severity levels (Critical, High, Medium, Low), descriptions, CVSS scores, and fix versions.
• JSON: A machine-readable JSON representation of the full audit result.
• HTML: A detailed, styled HTML report suitable for browser viewing, featuring a searchable DataTables interface, severity badges, and JFrog Research advisories.

To run tests against an Artifactory instance, define the following environment variables. If running a local instance with default credentials, use these values:

• CONAN_TEST_WITH_ARTIFACTORY: Set to 1 to enable Artifactory tests.
• ARTIFACTORY_DEFAULT_URL: The base URL for the Artifactory repository (e.g., http://localhost:8081/artifactory).
• ARTIFACTORY_DEFAULT_USER: The Artifactory username.
• ARTIFACTORY_DEFAULT_PASSWORD: The Artifactory password.

Warning: Running tests with a real Artifactory instance will create repositories on the fly; use a dedicated testing server.

$ export CONAN_TEST_WITH_ARTIFACTORY=1
$ export ARTIFACTORY_DEFAULT_URL=http://localhost:8081/artifactory
$ export ARTIFACTORY_DEFAULT_USER=admin
$ export ARTIFACTORY_DEFAULT_PASSWORD=password

The print_graph_packages(graph) function provides a detailed view of the packages within a dependency graph, focusing on their binary status and remote origins. It categorizes packages into:

• Requirements
• Test requirements
• Build requirements

For each package, it reports the status, such as:

• Skip: Binary is skipped.
• Missing or Invalid: Binary status issues (shown in red).
• Build: Package needs to be built (shown in yellow).
• Other statuses (e.g., specific binary IDs) are shown in cyan.

If the output level allows LEVEL_DEBUG, it also prints a compact summary of the package information. If the output level is not LEVEL_VERBOSE, it provides a summary list of Skipped binaries.