Skip to main content

Cookiecutter template for C++ with several libs ready to be used.

Project description

Build Status

Cookiecutter template for a C++ package.

Credits

This is basically a fork of Cookiecutter.

Features

Quickstart

Install the latest Cookiecutter if you haven’t installed it yet (this requires Cookiecutter 1.4.0 or higher):

pip install -U cookiecutter

Generate a Python package project:

cookiecutter https://github.com/grhawk/cookiecutter-cpp.git

Enter the newly generated folder. Make sure the Conan profile is configured:

conan profile list

If you don’t have a Conan profile, you can create one with conan profile detect –force. At this point, according to CMake-Conan-Integration, you can run:

mkdir build && cd build;
cmake -DCMAKE_PROJECT_TOP_LEVEL_INCLUDES=cmake/conan_provider.cmake ..
cmake --build .

This will prepare the needed C++ libraries and compile the example code. You can now test the compiled code:

./sandbox/cpp_boilerplate-sandbox

and run the unittests:

ctest

The created folder is already a git repo that you can push on github and has already a basic CI implemented to test the code with CircleCI.

For more details, see the cookiecutter-pypackage tutorial.

Not Exactly What You Want?

Don’t worry, you have options:

Fork This / Create Your Own

If you have differences in your preferred setup, I encourage you to fork this to create your own version. Or create your own; it doesn’t strictly have to be a fork.

  • Once you have your own version working, add it to the Similar Cookiecutter Templates list above with a brief description.

  • It’s up to you whether or not to rename your fork/own version. Do whatever you think sounds good.

Contributing

  1. Fork the project.

  2. Edit whatever you feel like.

  3. Describe the changes on the “unreleased” tag in the CHANGELOG.md.

  4. Create a Merge Request to the main branch.

Once a new branch has been merged, it is enough to create a new semver tag to generate a new version of the cookiecutter repo.

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

cookiecutter-cpp-3.2.1.tar.gz (4.3 kB view details)

Uploaded Source

Built Distribution

cookiecutter_cpp-3.2.1-py3-none-any.whl (4.2 kB view details)

Uploaded Python 3

File details

Details for the file cookiecutter-cpp-3.2.1.tar.gz.

File metadata

  • Download URL: cookiecutter-cpp-3.2.1.tar.gz
  • Upload date:
  • Size: 4.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.9

File hashes

Hashes for cookiecutter-cpp-3.2.1.tar.gz
Algorithm Hash digest
SHA256 94ad8533dd23c57e2662ba084be6af656836f2950ee371af84756cfeead42194
MD5 c095b75d48174ac6c17a53eba92d9d1b
BLAKE2b-256 23923b66fd33b8e60565b76c77c1183a93d27f1a0964da4be991c9dce2a2e4c9

See more details on using hashes here.

File details

Details for the file cookiecutter_cpp-3.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for cookiecutter_cpp-3.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 bac8460d78d86777a2420a79f402eb6aa95c3688897dac8a29b2e60f686d2944
MD5 4e1c7fdc2f08aca64f00b87dfdbb2e3f
BLAKE2b-256 de6c05e90a03a3e3517828050b78797412a3d42670513eb51e8d9af5fe465de2

See more details on using hashes here.

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