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.97-cp311-cp311-win_amd64.whl (55.3 kB view details)

Uploaded CPython 3.11 Windows x86-64

testghacookiecutter-0.0.97-cp311-cp311-win32.whl (50.0 kB view details)

Uploaded CPython 3.11 Windows x86

testghacookiecutter-0.0.97-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.97-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.97-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.97-cp310-cp310-win_amd64.whl (55.5 kB view details)

Uploaded CPython 3.10 Windows x86-64

testghacookiecutter-0.0.97-cp310-cp310-win32.whl (49.9 kB view details)

Uploaded CPython 3.10 Windows x86

testghacookiecutter-0.0.97-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.97-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.97-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.97-cp39-cp39-win_amd64.whl (55.5 kB view details)

Uploaded CPython 3.9 Windows x86-64

testghacookiecutter-0.0.97-cp39-cp39-win32.whl (50.2 kB view details)

Uploaded CPython 3.9 Windows x86

testghacookiecutter-0.0.97-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.97-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.97-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.97-cp38-cp38-win_amd64.whl (55.3 kB view details)

Uploaded CPython 3.8 Windows x86-64

testghacookiecutter-0.0.97-cp38-cp38-win32.whl (50.0 kB view details)

Uploaded CPython 3.8 Windows x86

testghacookiecutter-0.0.97-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.97-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.97-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.97-cp311-cp311-win_amd64.whl.

File metadata

File hashes

Hashes for testghacookiecutter-0.0.97-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 b03a9ca9ef46780d6b209680f6a25ff88c42142bd05b10566301670ed61eaa3b
MD5 50c8b938bdf0ca0a270eb384f6e72572
BLAKE2b-256 5db87391a8313c817908ee77cfb39703a69f6f779061dd51b6b6d55e6571df77

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.97-cp311-cp311-win32.whl
Algorithm Hash digest
SHA256 ee971a391d15a74d0ba6f50f3c3c5669f3f63fe11553010af6fc5f5234312a1d
MD5 035ac2e8533ad9a3536b76f9dc06dad9
BLAKE2b-256 dcb06dfd2723ee95b4d1e77c7ba3d98b9b9bb79ff5dcca48475ee1b9b0ae9f96

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.97-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 443eee0186101b6f57aa911f4560b4fcab13fa3262819b939aa58963c3f9c92f
MD5 93cd1f90a7460881faca71bf9fa22023
BLAKE2b-256 4710f26c05afab62bab54663755af24249664d6bf166cae009e3a24f4808d14b

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.97-cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm Hash digest
SHA256 d8450ef5268c6c1b936ddad0d4297c692cf98f90592504f114739dd235f24fa9
MD5 ff7278ef1420e4399a168932914b6f92
BLAKE2b-256 1a038a5ee85f8ae59855c5faa2e3fac2c2e9f9c0076091577836731869c4d6c3

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.97-cp311-cp311-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 265989729f10cac4d8f7237d796dbf24c48ce7742fa7c4984563fe1240e58637
MD5 e2bdd0c0a53c23fcfd60b75811ff72c9
BLAKE2b-256 4181835a998ff1b3a0bd07cf918c045604b910eda3f7e37242c066f21c7b2883

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.97-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 f197f6ebd65e204c4462a4188c5b76eca995e6a53315e833cc33f795638d93ea
MD5 ef86efeb1031c4ec2d12877b254c892a
BLAKE2b-256 58898a196dc0706627886cd1bd7704bacdd59384a0ac25a059a9735c75237965

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.97-cp310-cp310-win32.whl
Algorithm Hash digest
SHA256 e3a34faef7ff910aa05b9c2f1db4860498a46f0b7d0d1f53a5ae231524a69770
MD5 d2223b44ff8c23e16c15a774bf01114f
BLAKE2b-256 b999de30b08e66ce3c21f6f216ce01f9843555e738454e9de9f7d67b5c83ff8c

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.97-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 3bd9412486d4979518d96b32ca0aae59430743096c9bb0416744739e136431bb
MD5 60d7b4987aaab1b65f7dae31f97c2e25
BLAKE2b-256 a4ef1c9e596280192b6bf19ae540f7afaeee07c6952883520e25c898cbdae034

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.97-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm Hash digest
SHA256 73e860a76e040aae845f42532f7c0464859659de2543fa019317749353a0be9e
MD5 bdc8a75fe50eace9d32d3b5da77da876
BLAKE2b-256 997999043002564a0c7847bc9ad168eb0d44eced0c2ddd06a10eb58b96cb9df6

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.97-cp310-cp310-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 c855682c5e747541abe1a196a9f5d973f849ce8e0c650325a2518764fb756aab
MD5 a76cd10b4c4119dd41adc915cc4d62c2
BLAKE2b-256 09b73f4e1da15125e2f5f6f414ae737ddb0b4c98fa953ac41e306e0a293b587a

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.97-cp39-cp39-win_amd64.whl
Algorithm Hash digest
SHA256 caf48add4a67371e4314dcb893ff658c84c5f4ca4c1be2ac02eee9f4af441fe9
MD5 6a2b31825d0f0a515628c04b7a22691d
BLAKE2b-256 ed2d96c2026540c5a7fbb3d2794af01199bf970c43a9678eb3025306d840bc6f

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.97-cp39-cp39-win32.whl
Algorithm Hash digest
SHA256 5ed743dce85480eb09ec16aaf132001a8172dd8e6c0402a37fe974b1340ab5f3
MD5 a2cddb8a8b78b2e8ef306d1b7a6c46c8
BLAKE2b-256 139713d155b1fae1b2d3083394fb0f4df8af27d6f169ad3ec61cbcd72e19311d

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.97-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 00931c13e82b4b36c54789d600e496228dcfd01771ebb32daf53f31023b3c090
MD5 5c2bca665a9eb57c858e5f665db40e0c
BLAKE2b-256 340b116290c092e8dbc15b83a10c842ea636b83e1aa9cdf2164676556f18d957

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.97-cp39-cp39-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm Hash digest
SHA256 48a4def4b0354182040d5940255301ee4a6b2aebfbc1516510bd9c0305488a38
MD5 3baebd7eb616f1371fa5d35380c2f771
BLAKE2b-256 c2c798aa4ffcb82c3b4e3787fb4b14605b09fe1e2f92d81ab7819950eb1187c8

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.97-cp39-cp39-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 9fa6afe9f2c52bd5a6384b096daa53766c8691d3bfdd8eb1404cb0f5f29b2b50
MD5 f88549dbf47752e4313766723815c91c
BLAKE2b-256 a11199dd195e9a75e985f918c5124def1296c147d5cc4548a67cd5753369f93a

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.97-cp38-cp38-win_amd64.whl
Algorithm Hash digest
SHA256 3260d858f423e6cb415b0fae76c733ae8fdb1543066642ae515d1e86945a2371
MD5 ac126b205eb1545406b96f0cbe8bfe3e
BLAKE2b-256 f28ff67745874416d254ec57a37bf7afad2d57185321c0a28db39035358c6fa2

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.97-cp38-cp38-win32.whl
Algorithm Hash digest
SHA256 98364b6bdcada6d5371f6e450511ec941248b7ab57c41aba4a59a7c29e67fc03
MD5 aa294cfdb01064abc65446f97c88af62
BLAKE2b-256 d4513a46786c70bff84d3f63deaa42bf86e7b1118a705ce05a24155eeb10dd25

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.97-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 9d672272c631dfba01a1cd1eed2aca9a857af658f1ae8325ba082acccbbf8833
MD5 32a11bc29654436aaa257510d2455166
BLAKE2b-256 27ff89dff9b46925eeab0b53bbcadbbc62803fe692cd65256e92238e89b728c6

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.97-cp38-cp38-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm Hash digest
SHA256 cf1a39680e4b3288158ab50be72b89d36c1177d143a9b68c0b8febce3460be20
MD5 ce77d3a900c661d21cf126ac02c1bf4c
BLAKE2b-256 ec6ec14aff7bc52419548448a8e7f27574d37767e2084b195aef825a2301edbf

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.97-cp38-cp38-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 e621f45ffea94aeb2cc56db49d329db9dc549dfe40f516c2c3cc46fb8c892d19
MD5 b4ea5d3ae2eb13e6160059334af18e9d
BLAKE2b-256 68b32d28420a4b151cfbae82bdece34a073ee1a3504e634418bf6882ddb8a2eb

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