Skip to main content

Helpers and tools that make working with conan more convenient.

Project description

Helpers and tools that make working with conan (e.g., scripting) more convenient.

The classes in this package provide an API for (a subset) of the conan features based on wrapping the conan command line tool. We opted for this approach because the internal conan API, as opposed to the command line tool, is not stable at the moment.

Installation

ConanTools releases are automatically deployed to PyPI as ConanTools . Subsequently, acquiring an up-to-date version for usage within python scripts is possible using the following command:

$ pip3 install ConanTools

Alternatively, for usage within a conanfile.py using python_requires, ConanTools are also provided as conan package on Bintray. Adding the remote and downloading version 0.3.5 is achieved using the following commands:

$ conan remote add bt_nioshd "https://api.bintray.com/conan/nioshd/conan"
$ conan download -r bt_nioshd ConanTools/0.3.5@nioshd/stable

Building the Sphinx Documentation

When Sphinx is installed (i.e., pip3 install sphinx sphinx-autodoc-typehints), the HTML API documentation for this package can be built via the following sphinx-build invocation:

$ sphinx-build doc doc/_build/html

Alternatively, the sphinx command on the setup.py file can be used.

$ python3 ./setup.py sphinx

Either way, the API documentation gets automatically generated by executing sphinx-apidoc first. The resulting HTML output can be found in the doc/_build/html directory.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ConanTools-0.4.1.tar.gz (13.6 kB view hashes)

Uploaded Source

Built Distribution

ConanTools-0.4.1-py3-none-any.whl (16.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page