cbake

Published:

View on Github

cbake

Easy to use build tool for C and C++ projects, written in Python. Think cmake, but easier to use.

Features

  • Easy-to-write build files using the YAML standard
  • Select input directory and output directory
  • Write tests easily

Installing

  • You can run this package using both Python 2 and 3.
  • Install requirements using pip install -r requirements.txt
  • Create a virtualenv if you are just trying this out.
  • After creating a virtualenv, run pip install -e .

How to use

Example usages

Simple usage

$ cbake

Usage with input directory

$ cbake /path/to/input/directory

Usage with input and output directories

$ cbake /path/to/input/directory --output-directory /path/to/output/directory
OR
$ cbake /path/to/input/directory -o /path/to/output/directory

The Bake file

The build configuration can be simply put in a YAML file named: .bake.yml. A sample bake file is shown below:

# name of the project
project: project_name

# Which command to use for compiling your project
# Example: clang, gcc for C and clang++, g++ for C++ 
compile: gcc

# executables that you want to add, with the C/C++ files
# that you want to add to each executable
executables:
  first:
    - a.h
    - b.c
  second:
    - c.h
    - d.h

# This part adds the required compilation flags for your compiler
flags:
  - Wall
  - w

# flag to enable testing 
testing: true

# out of the executables defines above, you can select some to be run as tests like shown below
tests:
  - first

The above config will create the following commands:

$ gcc tests/test1/a.h tests/test1/b.c -o tests/test1/first.o -Wall -w
$ gcc tests/test1/c.h tests/test1/d.c -o tests/test1/second.o -Wall -w

Testing

To write tests for your project, you can add executables that contain the sources for tests. After compilation, you can run cbake . test with the previously used options and arguments, and the tests will be run.

Also, if you have not run cbake before in some directory and it contains some tests, you can directly run the test command and cbake will compile those executables on the fly!

Things to keep in mind

  • This cli should be used in the original sequence (cbake [OPTIONS] [DIRECTORY] COMMAND [ARGS])
  • For testing, the input directory needs to be specified, but for normal compilation it’s not needed. Example: cbake . -v test

License

 MIT License

Copyright (c) 2018 Man Parvesh Singh Randhawa

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Leave a Comment