ami-iit / cmakip Goto Github PK

CLI tool for one-line installation of C++/CMake projects.

License: BSD 3-Clause "New" or "Revised" License

Python 100.00%

cmakip's Introduction

cmakip

When working on virtual environments, Python projects can be installed with a single command invocation, for example pip install --no-deps . . Instead for CMake/C++ projects it is necessary to manually run mkdir build && cd build && cmake -DCMAKE_INSTALL_PREFIX=... .

cmakip is a command line tool to simplify this step, i.e. the compilation and installation of C++/CMake projects when working on environments such as conda environments or Python's virtual environments, similarly to what pip permits to do with Python projects.

Installation

First of all, make sure that you are in a conda environment or a Python virtual environment, then you can install cmakip as:

pip install --no-deps git+https://github.com/ami-iit/cmakip

Usage

Installation from a directory

cmakip can permit to quickly install a project in a directory, for example:

cd ~
git clone https://github.com/fmtlib/fmt
cd fmt
cmakip install .

This automatically creates a build_cmakip directory in the source folder and then installs it in the appropriate location:

Operating System	Environment Type	CMAKE_INSTALL_PREFIX
Linux&macOS	Conda	${CONDA_PREFIX}
Windows	Conda	${CONDA_PREFIX}\Library
Linux&macOS	Python venv	${VIRTUAL_ENV}
Windows	Python venv	Not Supported

A project installed like that can be uninstalled like:

cd ~/fmt
cmakip uninstall .

Installation from a repo

cmakip can also be used to install CMake libraries from a repo:

cmakip install git+https://github.com/fmtlib/fmt

This automatically clone the repo in ${CONDA_PREFIX}\src or ${VIRTUAL_ENV}\src, and then installs it.

A library installed like this can be uninstalled simply specifying the repo name:

cmakip uninstall fmt

FAQs

Does cmakip resolve dependencies?

No. In a sense, it is kind of equivalent to pip install --no-deps.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

BSD-3-Clause

cmakip's People

Contributors

Stargazers

Watchers

cmakip's Issues

Permit to specify an automatic install prefix different from Conda or virtualenv prefixes

At the moment, cmakip only permits to automatically install projects when a Conda or virtualenv prefix is active. In the AMI lab (https://ami.iit.it/) a common practice widespread among the members is to have an instance of the https://github.com/robotology/robotology-superbuild "active" in the system, and install CMake project in the install directory of the "activated" robotology-superbuild. Probably it could make sense to support such a workflow.

At the moment I can think of two ways of implement this:

1. Make cmakip aware of the robotology-superbuild in particular, checking if ROBOTOLOGY_SUPERBUILD_INSTALL_PREFIX is defined
1. Define a new environment variable observed by cmakip, called CMAKIP_INSTALL_PREFIX or similar, and define it in robotology-superbuild's setup.sh scripts.

I like option 2. to decouple cmakip and robotology-superbuild .

Permit to pass CMake options to cmakip

At the momement it is not possible to easily pass CMake option to the build created by cmakip.
Ideally we would like to be able to do something like that:

cmake install git+https://github.com/fmtlib/fmt -DFMT_MODULE:BOOL=ON

Support installing multiple projects specified in a text file

pip supports installing projects from a requirements.txt file (see https://pip.pypa.io/en/stable/reference/requirements-file-format/). To quickly install multiple repos, it could make sense to support something similar in cmakip, for example support:

cmakip install -r cmake_repos_to_install.txt

where cmake_repos_to_install.txt is:

git+https://github.com/fmtlib/[email protected]
git+https://github.com/gabime/[email protected]
git+https://gitlab.com/libeigen/[email protected]