Skip to main content

Add short description here

Project description

Welcome to My C++ Project

License: MIT GitHub Workflow Status PyPI Release Documentation Status codecov Quality Gate Status

Prerequisites

Building My C++ Project requires the following software installed:

  • A C++11-compliant compiler
  • CMake >= 3.9
  • Doxygen (optional, documentation building is skipped if missing)
  • The testing framework Catch2 for building the test suite* Python >= 3.8 for building Python bindings

Building My C++ Project

The following sequence of commands builds My C++ Project. It assumes that your current working directory is the top-level directory of the freshly cloned repository:

mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=Release ..
cmake --build .

The build process can be customized with the following CMake variables, which can be set by adding -D<var>={ON, OFF} to the cmake call:

  • BUILD_TESTING: Enable building of the test suite (default: ON)
  • BUILD_DOCS: Enable building the documentation (default: ON)
  • BUILD_PYTHON: Enable building the Python bindings (default: ON)

If you wish to build and install the project as a Python project without having access to C++ build artifacts like libraries and executables, you can do so using pip from the root directory:

python -m pip install .

Testing My C++ Project

When built according to the above explanation (with -DBUILD_TESTING=ON), the C++ test suite of My C++ Project can be run using ctest from the build directory:

cd build
ctest

The Python test suite can be run by first pip-installing the Python package and then running pytest from the top-level directory:

python -m pip install .
pytest

Documentation

My C++ Project provides a Sphinx-based documentation, that can be browsed online at readthedocs.org. To build it locally, first ensure the requirements are installed by running this command from the top-level source directory:

pip install -r doc/requirements.txt

Then build the sphinx documentation from the top-level build directory:

cmake --build . --target sphinx-doc

The web documentation can then be browsed by opening doc/sphinx/index.html in your browser.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

testghacookiecutter-0.0.95-cp311-cp311-win_amd64.whl (55.8 kB view details)

Uploaded CPython 3.11 Windows x86-64

testghacookiecutter-0.0.95-cp311-cp311-win32.whl (50.4 kB view details)

Uploaded CPython 3.11 Windows x86

testghacookiecutter-0.0.95-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (74.1 kB view details)

Uploaded CPython 3.11 manylinux: glibc 2.17+ x86-64

testghacookiecutter-0.0.95-cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl (79.7 kB view details)

Uploaded CPython 3.11 manylinux: glibc 2.17+ i686

testghacookiecutter-0.0.95-cp311-cp311-macosx_10_9_x86_64.whl (47.9 kB view details)

Uploaded CPython 3.11 macOS 10.9+ x86-64

testghacookiecutter-0.0.95-cp310-cp310-win_amd64.whl (56.1 kB view details)

Uploaded CPython 3.10 Windows x86-64

testghacookiecutter-0.0.95-cp310-cp310-win32.whl (50.3 kB view details)

Uploaded CPython 3.10 Windows x86

testghacookiecutter-0.0.95-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (74.1 kB view details)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64

testghacookiecutter-0.0.95-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl (79.7 kB view details)

Uploaded CPython 3.10 manylinux: glibc 2.17+ i686

testghacookiecutter-0.0.95-cp310-cp310-macosx_10_9_x86_64.whl (47.9 kB view details)

Uploaded CPython 3.10 macOS 10.9+ x86-64

testghacookiecutter-0.0.95-cp39-cp39-win_amd64.whl (55.9 kB view details)

Uploaded CPython 3.9 Windows x86-64

testghacookiecutter-0.0.95-cp39-cp39-win32.whl (50.6 kB view details)

Uploaded CPython 3.9 Windows x86

testghacookiecutter-0.0.95-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (74.3 kB view details)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64

testghacookiecutter-0.0.95-cp39-cp39-manylinux_2_17_i686.manylinux2014_i686.whl (79.9 kB view details)

Uploaded CPython 3.9 manylinux: glibc 2.17+ i686

testghacookiecutter-0.0.95-cp39-cp39-macosx_10_9_x86_64.whl (48.0 kB view details)

Uploaded CPython 3.9 macOS 10.9+ x86-64

testghacookiecutter-0.0.95-cp38-cp38-win_amd64.whl (55.8 kB view details)

Uploaded CPython 3.8 Windows x86-64

testghacookiecutter-0.0.95-cp38-cp38-win32.whl (50.4 kB view details)

Uploaded CPython 3.8 Windows x86

testghacookiecutter-0.0.95-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (74.1 kB view details)

Uploaded CPython 3.8 manylinux: glibc 2.17+ x86-64

testghacookiecutter-0.0.95-cp38-cp38-manylinux_2_17_i686.manylinux2014_i686.whl (79.6 kB view details)

Uploaded CPython 3.8 manylinux: glibc 2.17+ i686

testghacookiecutter-0.0.95-cp38-cp38-macosx_10_9_x86_64.whl (47.9 kB view details)

Uploaded CPython 3.8 macOS 10.9+ x86-64

File details

Details for the file testghacookiecutter-0.0.95-cp311-cp311-win_amd64.whl.

File metadata

File hashes

Hashes for testghacookiecutter-0.0.95-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 7b7b79ba1ee4f29955a9c54aafe5d4cc15f6eb69919e8c3b7005fbbfcae1ec1e
MD5 ee35985468797a109ef38b2e74e932d9
BLAKE2b-256 76c6b467951b562c1f56a2b037a578efe80574c5d0c58a6ba087b31cd1ac05be

See more details on using hashes here.

Provenance

File details

Details for the file testghacookiecutter-0.0.95-cp311-cp311-win32.whl.

File metadata

File hashes

Hashes for testghacookiecutter-0.0.95-cp311-cp311-win32.whl
Algorithm Hash digest
SHA256 6934e9b1a83a88b5d6aa5c34b0f6c8671a4c553f7f4f60b0327306d3601a00cf
MD5 adfe51343e072304357af96c1b85a1c4
BLAKE2b-256 90f8cb95840d37c6375f391a50f239617bda41087c4c0b3ffe6aed37bd42970c

See more details on using hashes here.

Provenance

File details

Details for the file testghacookiecutter-0.0.95-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for testghacookiecutter-0.0.95-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 f71bf9fddc9e2243fa0e1ca6cf4006ded8fde54d23135e04080c313ad967dbd0
MD5 e7b6733bc7ba0dc2a8f64dc6cbeb6fa8
BLAKE2b-256 1e43326168aa19a6eef35fc9a17cf54cf72c5de3b9f01ea4300cd9eab68e79dd

See more details on using hashes here.

Provenance

File details

Details for the file testghacookiecutter-0.0.95-cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl.

File metadata

File hashes

Hashes for testghacookiecutter-0.0.95-cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm Hash digest
SHA256 3dc3c78ddb95c103bed7659dcab65fadf162441c3bbd5218904e3f7ea401c2a7
MD5 6cbf7475c3b30bfe7dec78d3c573537e
BLAKE2b-256 388d25dec2617fda52920a7ec07dd2a870ce664f7a6c42327e633ec03b6b4a34

See more details on using hashes here.

Provenance

File details

Details for the file testghacookiecutter-0.0.95-cp311-cp311-macosx_10_9_x86_64.whl.

File metadata

File hashes

Hashes for testghacookiecutter-0.0.95-cp311-cp311-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 6dbef036174dbf3118316b13fd93ee7d6616168c0e92d4bd4502dfc655fb1a06
MD5 ab7e4f3687849d97bb7da0abfe90f754
BLAKE2b-256 9074a52db102f6e74ba5a387f8f11c9f0194a233ca50775bb095e5bc30bfbd6e

See more details on using hashes here.

Provenance

File details

Details for the file testghacookiecutter-0.0.95-cp310-cp310-win_amd64.whl.

File metadata

File hashes

Hashes for testghacookiecutter-0.0.95-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 e14b534b3adcc5f8449f259df17fe29122cc3ce251694f6b3ccae4b641fb92d3
MD5 f9c70606afe407f2324d498a93b0e561
BLAKE2b-256 e09191c576c56d407b1d2ac8cfd7e5a792a30d8e50d0370fff13e3e5c3b72003

See more details on using hashes here.

Provenance

File details

Details for the file testghacookiecutter-0.0.95-cp310-cp310-win32.whl.

File metadata

File hashes

Hashes for testghacookiecutter-0.0.95-cp310-cp310-win32.whl
Algorithm Hash digest
SHA256 c4240c10bf96bc67077767f4d130ad8b7267d23424ad99c12ca139d43100c466
MD5 57e83805d8574e07c8ef6b7dd0c2fe78
BLAKE2b-256 7a40c61395126897d4f64cde8d22fceaa200b6e81ee665dd380ca7120d914a8f

See more details on using hashes here.

Provenance

File details

Details for the file testghacookiecutter-0.0.95-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for testghacookiecutter-0.0.95-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 5533a435cc60b9312427399dd4a75517abe0cd8686d87e4b257232cc11c687f9
MD5 3d5a3a99c0d3d2cb58ecfac317ccfc88
BLAKE2b-256 34083fcd378464263bfc81beb3e6338a3a1105898ec45a0602e1046026e128f9

See more details on using hashes here.

Provenance

File details

Details for the file testghacookiecutter-0.0.95-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl.

File metadata

File hashes

Hashes for testghacookiecutter-0.0.95-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm Hash digest
SHA256 b18f844a6637da1593961eb3f238627a24f3e94afe38ce1835bdc6e5b4bd292f
MD5 9d896b5e0053537fe408f4fa41e6b33d
BLAKE2b-256 f4f1a00def6d85788c80dbf3bb5507f909e39a15831ee084ea155cfffbde2a78

See more details on using hashes here.

Provenance

File details

Details for the file testghacookiecutter-0.0.95-cp310-cp310-macosx_10_9_x86_64.whl.

File metadata

File hashes

Hashes for testghacookiecutter-0.0.95-cp310-cp310-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 906b1cf70051a5a86110e462396e6f91e4a453b3cba41c8d3dd35557fe47286c
MD5 f2c384a695c7824eecb6752efda63832
BLAKE2b-256 3cfeec45768990237a3d35f60aa70b0791baa133fd5cba099d5ac3a178aa9c16

See more details on using hashes here.

Provenance

File details

Details for the file testghacookiecutter-0.0.95-cp39-cp39-win_amd64.whl.

File metadata

File hashes

Hashes for testghacookiecutter-0.0.95-cp39-cp39-win_amd64.whl
Algorithm Hash digest
SHA256 82f613c7ab16991b2e9e4327ffb93cbb9dfc21920ae0b4d9063463dde0bca19b
MD5 7b2cef03f2cc4fbfa495923482c58141
BLAKE2b-256 7a95f1c4ff851fc1e748798fb9c53244b6fa09ac27e5e4da25d10591727ee287

See more details on using hashes here.

Provenance

File details

Details for the file testghacookiecutter-0.0.95-cp39-cp39-win32.whl.

File metadata

File hashes

Hashes for testghacookiecutter-0.0.95-cp39-cp39-win32.whl
Algorithm Hash digest
SHA256 7b72282e6e18514f5446434859ff6021bc6d8b38ca970fc786c896c713a5e7a5
MD5 f5ac1db790dd3c8ada2e7b94c6317e09
BLAKE2b-256 f3bbfcae13d3cbf2d970bf8a001fbddfba92b6dc78f2984916ccdb6b5ae03130

See more details on using hashes here.

Provenance

File details

Details for the file testghacookiecutter-0.0.95-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for testghacookiecutter-0.0.95-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 d9632051be2c9f1c2e5ca3964665212e1de42d83dcde0ea2464e801ebfa4d79f
MD5 2bfb2c1f3feb57fe085e8fdd555ff514
BLAKE2b-256 5553612722633257fbc1191c5080eb252497a6bac6cced89a3f0ebb7ef588835

See more details on using hashes here.

Provenance

File details

Details for the file testghacookiecutter-0.0.95-cp39-cp39-manylinux_2_17_i686.manylinux2014_i686.whl.

File metadata

File hashes

Hashes for testghacookiecutter-0.0.95-cp39-cp39-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm Hash digest
SHA256 e0b71dd437cab3977132d211bbd11c677b4636d01e0e694d53b6587a5432d8ed
MD5 7fa28e8c1b5f90ffde09e58e64a84b1f
BLAKE2b-256 477bc5f9a3d23b9f3a2d84a7a4464ef5cb6a08f6fee73d86282d08b865482095

See more details on using hashes here.

Provenance

File details

Details for the file testghacookiecutter-0.0.95-cp39-cp39-macosx_10_9_x86_64.whl.

File metadata

File hashes

Hashes for testghacookiecutter-0.0.95-cp39-cp39-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 a12c51dd9e7253e94e9458ef844c007c55c815bbe6172dc81610e3a5f974e5ab
MD5 84c77f188ec78df9f1660f8a4fa70b14
BLAKE2b-256 f8a357cf366e9e65a7825d7c1b47914e1a33a350dffe6916fd5853bc488b9a48

See more details on using hashes here.

Provenance

File details

Details for the file testghacookiecutter-0.0.95-cp38-cp38-win_amd64.whl.

File metadata

File hashes

Hashes for testghacookiecutter-0.0.95-cp38-cp38-win_amd64.whl
Algorithm Hash digest
SHA256 25d453ed91c9177fa60c2e17dfe47785609f9997f6ffbad88a0ebce1de9026ff
MD5 202735901712220986244413a6d1742b
BLAKE2b-256 63d20aea3e0fc42d41c178817b9e3161d9b0483c4f079ce9134b737d8abe5254

See more details on using hashes here.

Provenance

File details

Details for the file testghacookiecutter-0.0.95-cp38-cp38-win32.whl.

File metadata

File hashes

Hashes for testghacookiecutter-0.0.95-cp38-cp38-win32.whl
Algorithm Hash digest
SHA256 abc72ec8f2134751a6dfd84cdd44747891e93d29340b7d4d0c7fa87257465ea8
MD5 fbc3a66a8f8437781731cd94cb5250e6
BLAKE2b-256 7c2089febeb2097fddc6391720bd72330493dd91a233200ca1b7282a5813bc59

See more details on using hashes here.

Provenance

File details

Details for the file testghacookiecutter-0.0.95-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for testghacookiecutter-0.0.95-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 390ea148b72e193b8301dff62bc66b1aa96806c8d523f0612bd07971847c4b22
MD5 04c072882bb6e1754c7c9e28544f6d81
BLAKE2b-256 faea4b76602efbaecd327a4996d155971909c18d9a4d41a637ef3935411fb8af

See more details on using hashes here.

Provenance

File details

Details for the file testghacookiecutter-0.0.95-cp38-cp38-manylinux_2_17_i686.manylinux2014_i686.whl.

File metadata

File hashes

Hashes for testghacookiecutter-0.0.95-cp38-cp38-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm Hash digest
SHA256 1be6456ded425a4859d9208cdbd20a3a328cc5a9060f4eea7bbc2f45f106231b
MD5 0773a6f082539d1d8478c6492ca72672
BLAKE2b-256 0a7d9bcb3dba132b59cb93254e04f724b55d568710bd8c9dd1c77846c968c7e6

See more details on using hashes here.

Provenance

File details

Details for the file testghacookiecutter-0.0.95-cp38-cp38-macosx_10_9_x86_64.whl.

File metadata

File hashes

Hashes for testghacookiecutter-0.0.95-cp38-cp38-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 c6d0f6ae168b2ca064df0d80267085c3d57200b215e26e64fa537dcc27e5595d
MD5 efc9c5c85c5497494d15a722c4bcdf88
BLAKE2b-256 8e668e62267c728abfa741ba3f8f58f30195f58d0a9d1ca1da9b58c13a88760f

See more details on using hashes here.

Provenance

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