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

Uploaded CPython 3.11 Windows x86-64

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

Uploaded CPython 3.11 Windows x86

testghacookiecutter-0.0.93-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.93-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.93-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.93-cp310-cp310-win_amd64.whl (55.9 kB view details)

Uploaded CPython 3.10 Windows x86-64

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

Uploaded CPython 3.10 Windows x86

testghacookiecutter-0.0.93-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.93-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.93-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.93-cp39-cp39-win_amd64.whl (55.7 kB view details)

Uploaded CPython 3.9 Windows x86-64

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

Uploaded CPython 3.9 Windows x86

testghacookiecutter-0.0.93-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.93-cp39-cp39-manylinux_2_17_i686.manylinux2014_i686.whl (79.8 kB view details)

Uploaded CPython 3.9 manylinux: glibc 2.17+ i686

testghacookiecutter-0.0.93-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.93-cp38-cp38-win_amd64.whl (55.5 kB view details)

Uploaded CPython 3.8 Windows x86-64

testghacookiecutter-0.0.93-cp38-cp38-win32.whl (50.3 kB view details)

Uploaded CPython 3.8 Windows x86

testghacookiecutter-0.0.93-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (74.0 kB view details)

Uploaded CPython 3.8 manylinux: glibc 2.17+ x86-64

testghacookiecutter-0.0.93-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.93-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.93-cp311-cp311-win_amd64.whl.

File metadata

File hashes

Hashes for testghacookiecutter-0.0.93-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 5f20daa074913ab9378fbb61f6a2dd0ff96bf7765f321a6ba78bf17660a969d7
MD5 6e404110df17bbf5814155821fef5c39
BLAKE2b-256 6a203ef115527db5221d0ef546205ea877bf45741b8a50aaf0726851c30f25b7

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.93-cp311-cp311-win32.whl
Algorithm Hash digest
SHA256 78999b410787e17c169324260a507e94347e18951c39bd4db493618a8913c963
MD5 93f4219ba82ed32e6901344e80181e40
BLAKE2b-256 afee5d9e0b520b910b7013226d92cb230ec875cfb0edff3b81db2e8b849cd190

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.93-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 39baeec391e1c5d2b7905b7df94a3bf06dedd2fcf7bc1fdb6bdc0146d108328b
MD5 e149bb838aa31e58cccf145a0702f428
BLAKE2b-256 9a3b24d5d85a3d3bc5fb32fb13cc5becae190d0a95afd315e0fa1ee3ac6095bb

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.93-cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm Hash digest
SHA256 6b8f3821c42bd7050cc9a722d73af4303e0ddfdc148280bcd898e6cae1e8831e
MD5 ad654e8ba2af30f569f62fb6a3c7202a
BLAKE2b-256 4f2319a6e05ab132d8c5699f7987d564a42e906d3bb759b6674cadb71d234592

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.93-cp311-cp311-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 61028d95eb8d30cc8ed93ec2f73938926699913b792704c12fa4b6920e0046b7
MD5 91ae34a3db5754222d30db0287c599cd
BLAKE2b-256 b7e4db44df77b99784845ab2d37fd96a0f158ff83b5373bd58215d39b7417467

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.93-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 02e0096676a12259328dbd9a27af22f2ea57fe523243fd915b2adbcbef0dcee7
MD5 e068d2196383e3698f70d691f5d42f2a
BLAKE2b-256 e08244a6ae18a8a078600cad066be2c5789eb851cc293b83a99ab82bb7c7f34d

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.93-cp310-cp310-win32.whl
Algorithm Hash digest
SHA256 8ef0934b928bcd535e20dfb66faee8d77e1fab4b70944cb4c51590186537a38a
MD5 545b5b0ba011a0024ac867dccf1829b6
BLAKE2b-256 855653cdd7af6726df056d4ecdaed345a79dbe9ec5e4be775b7728aa0efbc5cc

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.93-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 1228593727c4462a1c9fe37c3542697c1a5b746f629f3c06b44566e6eaa9d3e3
MD5 bc89d5ed14a58c0a7a6133b13de586f9
BLAKE2b-256 04d0559e9ef13babf25eaa2d30daaf28d1dab87baba3d972230bc566aff8df82

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.93-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm Hash digest
SHA256 6d51f2af6f994cbf48a712232c6d495c4abde83a82fa8f6699ecbee6ccf22dbc
MD5 31ed4feae5e213788b9f6c0f89d5f958
BLAKE2b-256 9239180879351d6ad40ee1457e69edd7b43fdda64919f1d6cd0dc983a174cc74

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.93-cp310-cp310-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 a91d528ea58a560b866edd0c220718c0526cdf35bc7ae5e10e4c92f3ddd657de
MD5 eff6dee67dca04b60bad068567b43356
BLAKE2b-256 4a57af27884b1e84c31b0cead6ca55da9cd37066d2237bcf5bc43248d56b154a

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.93-cp39-cp39-win_amd64.whl
Algorithm Hash digest
SHA256 0e7ef33cd6655d73bf8fd8b188fcd560bce3e8a267de25e0da8ff4788057aedb
MD5 eb56ff52b4b53c7682e9522cd3bb6892
BLAKE2b-256 a09f760f5df93b39f4535df55008a230da5ca583387d736ffc39052076bd348a

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.93-cp39-cp39-win32.whl
Algorithm Hash digest
SHA256 567ace7e8f48c6da12475ef76f5349321de7489fde35d8332e37799f882d43a5
MD5 55e4bba2eff2d0c2963c150422ac7ac9
BLAKE2b-256 7ce3fbb6e4a803a00d256f5859f1d3365b9403e6cc9799cb66ce6d1291833ffb

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.93-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 ad312e612a58fe85451b4e61002c0deedc38bfe6f3a657080ceead82302a6829
MD5 871791ad899c365abdc4fc9c62061b72
BLAKE2b-256 522fbc6612ba31080260cac2c37c0d864706dde4eb1e55289bb948c26a609ad5

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.93-cp39-cp39-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm Hash digest
SHA256 33c25b89cdc8481e7ef0ad20de8f6731673c2f06a8119548dea3cb6a255f459c
MD5 69381894877a42bbd7d14ac3769ad711
BLAKE2b-256 e243186a2fbf1b5df9dd9346a37778fb07ef90f7b05675b079aa2bebe8a83bef

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.93-cp39-cp39-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 0c35bc8e5d1e8510062dbee40d5a0e0e71e2e87a195c3b761cebe5fe01d10889
MD5 6b76a6137e4a85d4cdc06b987b39b178
BLAKE2b-256 fab4d1801edd1aad76a279fd4736651a3baa5c3829b87aa2e593b01557955ea0

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.93-cp38-cp38-win_amd64.whl
Algorithm Hash digest
SHA256 0edbc6a7fd6558fad7c995cfc45a4b79fe6ab6752bb28d5fe9ee722260eb005e
MD5 cafda5ddb7dd9ad346c345cc5c4462f9
BLAKE2b-256 e74552d879a71edf41e6d732c83402bc09aea2f53056cb49e2c93d1fed5f7cac

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.93-cp38-cp38-win32.whl
Algorithm Hash digest
SHA256 6b59d4b591df5cd11dbbf776d3225d97111c98f0a5d05f47dbf68670852fb67f
MD5 5213d8f534bf627e696624116163507b
BLAKE2b-256 c2ca5083cbbd8321bd2af3434a11d87dfb25e3b3ee6100a3d2105f44ded5b2f5

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.93-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 47554ca3916f28e78e83f77d7c4d701eae72f1df21921c9fce565bceed7ef449
MD5 f41054c90d924fd6fd34b2fdfaf658e2
BLAKE2b-256 64245d0501a2bc51ae255d3a969d3b7e173d24e631c13abcf4d468ee48e32d36

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.93-cp38-cp38-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm Hash digest
SHA256 2ef300d599195e25555b58314571383ed9b7772a8db197eadbe8d70d24ea2e65
MD5 3078ff0d3ea60502a3b1e117ba75c084
BLAKE2b-256 c61cb411cbb93818968818cec43a1eaa920d0381b5c181388f000a936d7d9ccf

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.93-cp38-cp38-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 d67d58b8ba781a28a74b32158a552c8b26f54db9d1521aa9ee0a95346a952cdc
MD5 e232b29cc135efba131bd775c923e54f
BLAKE2b-256 5d517a5b594932fd1064c09bc0a85cdc43b94a410b377d27fc3bf2c75b3ae315

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