Simple dependencies manager for cmake projects in your workspace
Project description
wks: Simple CMake workspace manager
How it works
The basic purpose of wks
is to spawn repositories to build a project, then generate a CMakeLists.txt
containing add_subdirectory()
directives for all of them.
This way, the project can be built using the top-level generated CMakeLists.txt
.
Usage
The following commands are available:
wks install [repository]
: If a repository is given,wks
will install it first. Then,wks
will scan for dependencies in thewks.yml
files (see below) and install them until all requirements are met. This way, it is possible that dependencies of dependencies are installed. Callingwks install
without repository argument will cause dependencies scan. TheCMakeLists.txt
will eventually be generated.wks cmake
: This will cause theCMakeLists.txt
to be re-generated.wks build [target]
: Will create a build and run it.wks
will try to create a Ninja build, and fall back to makefiles if it is not available. The[target]
you can pass will be given to the build command (make [target]
orninja [target]
). The build will be stored inbuild/
directory.wks pull
: Will run agit pull
in all repositories. This will then scan for dependencies (equivalent towks install
with no argument) and re-generate theCMakeLists.txt
.wks status
: Gives insight on the status of your repositories, this will check for:- Untracked files
- Changes without commits
- Changes commited but not pushed
All sources will be stored in src/
, under src/vendor/repository
.
Repositories format
All repositories are fetched for GitHub, and repositories can have those formats:
vendor/repository
vendor/repository#branch
vendor/repository@tag
The wks.yml
file
The wks.yml
can contain the following sections:
deps
: a list of dependencies that the repository want to be installedoptional
: a list of optional dependencies, they will not be installed but it ensure that the projects will appear in the proper order in the generatedCMakeLists.txt
cmakes
: if theCMakeLists.txt
for this repository is not at the top level (or not unique), you can specify them using this sectioninstall
: a list of shell command that should be run post installcmake_prefix
: a list of directories to be added toCMAKE_PREFIX_PATH
An example is:
deps:
- rhoban/utils@v1.0
- rhoban/geometry@v2.0
cmakes:
- client
- server
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
wks-0.3.3.tar.gz
(8.0 kB
view hashes)
Built Distribution
wks-0.3.3-py3-none-any.whl
(12.0 kB
view hashes)