Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/derthorsten/cpp_cookiecutter
A cookiecutter template for a modern C++ project with python bindings
https://github.com/derthorsten/cpp_cookiecutter
cmake cookiecutter cookiecutter-c-plus-plus cookiecutter-python3 cookiecutter-template cpp cpp-library cpp14 pybind11 xtensor
Last synced: 2 months ago
JSON representation
A cookiecutter template for a modern C++ project with python bindings
- Host: GitHub
- URL: https://github.com/derthorsten/cpp_cookiecutter
- Owner: DerThorsten
- License: bsd-3-clause
- Created: 2018-02-25T14:53:38.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-07-25T08:12:21.000Z (over 2 years ago)
- Last Synced: 2024-10-17T16:54:16.029Z (3 months ago)
- Topics: cmake, cookiecutter, cookiecutter-c-plus-plus, cookiecutter-python3, cookiecutter-template, cpp, cpp-library, cpp14, pybind11, xtensor
- Language: CMake
- Homepage: http://cpp-cookiecutter.readthedocs.io
- Size: 5.55 MB
- Stars: 32
- Watchers: 3
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE.txt
Awesome Lists containing this project
README
=================================================
Cpp Cookiecutter
=================================================
.. image:: https://readthedocs.org/projects/cpp-cookiecutter/badge/?version=latest
:target: https://cpp-cookiecutter.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://travis-ci.org/DerThorsten/cpp_cookiecutter.svg?branch=master
:target: https://travis-ci.org/DerThorsten/cpp_cookiecutter
.. image:: https://circleci.com/gh/DerThorsten/cpp_cookiecutter/tree/master.svg?style=svg
:target: https://circleci.com/gh/DerThorsten/cpp_cookiecutter/tree/master
.. image:: https://dev.azure.com/derthorstenbeier/cpp_cookiecutter/_apis/build/status/DerThorsten.cpp_cookiecutter?branchName=master
:target: https://dev.azure.com/derthorstenbeier/cpp_cookiecutter/_build/latest?definitionId=1&branchName=master
Demo Project
------------------------
Have a look at `github.com/DerThorsten/cpptools `_, an
unmodified example project created with this cpp_cookiecutter.
Features
--------
Current features include:
* Readme on `readthedocs.org `_
* Modern C++ 14
* Build system with modern CMake
* `preconfigured conda recipe included `_
* Rendered projects have pre-configured CI scripts for: travis-ci circleci and azure-pipelines
* Rendering of projects itself is tested on several continuous integration plattforms as `travis-ci `_ `circleci `_ and `azure-pipelines `_
* `C++ unit tests with cpp doctest `_
* `Benchmark code with google benchmark `_
* Docs with sphinx breathe and readthedocs support
* `Google Benchmark `_ and `Doctest `_ are downloaded at cmake-config time via external-projects
since these dependencies are just for testing and benchmarking (and those are not yet available on conda)
* bumpversion
* `Python bindings are created via pybind11 `_
* An demo project `github.com/DerThorsten/cpptools `_ created by this cookiecutter, and automatically kept up to date via continuous integration
.. _rtd_unit_test:
Usage:
--------
Install _cookiecutter
.. code-block:: shell
$ pip install cookiecutter
After installing cookiecutter, use the cpp-cookiecutter:
.. code-block:: shell
$ cookiecutter https://github.com/DerThorsten/cpp_cookiecutter
This cookiecutter is bet used in conjunction with conda:
Assuming your package is named cpptools the following script
shows the usage of the generated project cookiecutter on Linux/MacOS
.. code-block:: shell
cd cpptools
conda env create -f cpptools-dev-requirements.yml
source activate cpptools-dev-requirements
mkdir build
cd build
cmake ..
make -j2
make cpp-test
make python-test
cd examples
./hello_world
cd ..
cd benchmark
./benchmark_cpptools
On a windows machine this looks like:
.. code-block:: shell
cd cpptools
call activate cpptools-dev-requirements
mkdir build
cd build
cmake .. -G"Visual Studio 15 2017 Win64" -DCMAKE_BUILD_TYPE=Release ^
-DDEPENDENCY_SEARCH_PREFIX="%CONDA_PREFIX%\Library" -DCMAKE_PREFIX_PATH="%CONDA_PREFIX%\Library"
call activate cpptools-dev-requirements
cmake --build . --target ALL_BUILD
cmake --build . --target python-test
cmake --build . --target cpp-test
.. code-block:: shell
cd cpptools
call activate cpptools-dev-requirements
mkdir build
cd build
cmake .. -G"Visual Studio 15 2017 Win64" -DCMAKE_BUILD_TYPE=Release ^
-DDEPENDENCY_SEARCH_PREFIX="%CONDA_PREFIX%\Library" -DCMAKE_PREFIX_PATH="%CONDA_PREFIX%\Library"
call activate cpptools-dev-requirements
cmake --build . --target ALL_BUILD
cmake --build . --target python-test
cmake --build . --target cpp-test