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

Uploaded CPython 3.11 Windows x86-64

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

Uploaded CPython 3.11 Windows x86

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

Uploaded CPython 3.10 Windows x86-64

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

Uploaded CPython 3.10 Windows x86

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

Uploaded CPython 3.9 Windows x86-64

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

Uploaded CPython 3.9 Windows x86

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

Uploaded CPython 3.8 Windows x86-64

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

Uploaded CPython 3.8 Windows x86

testghacookiecutter-0.0.96-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.96-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.96-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.96-cp311-cp311-win_amd64.whl.

File metadata

File hashes

Hashes for testghacookiecutter-0.0.96-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 4486eb4ef3f8c76e1c417137324ca11c4dbfa49b5ff4c400b5a7a6f09af6442b
MD5 0e7a3ccccdcb71d001e3bdbbc16352e4
BLAKE2b-256 83394f69023bbdc59110ba575bedd9cc5710c049649b977c59458c2142d61f46

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.96-cp311-cp311-win32.whl
Algorithm Hash digest
SHA256 383b060bacf23be3a0f414420e1d60fe749f226bc593dd81e2ea9715f24e4b2f
MD5 c0b97830f0a00e94d6aff72fdecf5028
BLAKE2b-256 95f318afb05d219e82153e36c991cbbcf5a50fa880b145494f1340e045525ea7

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.96-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 9b1e7a49e7f3b393350ea5184403543be15219888b021da08c415bd21b343c95
MD5 c28b86ee336ce671328f4ea5bc1012a1
BLAKE2b-256 65ff8b641d399573b0341d27363d5fffa65d386a055fd4b8cb7d50e8cb0b9844

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.96-cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm Hash digest
SHA256 1a0ff9087984389032a1db66c91029f1262b6e87177a93c4a3824a28875d1ac1
MD5 f1d1ec78c6c258b73962a638b6a3839d
BLAKE2b-256 025855ecace18d245f33adb32b3158a1634d90084ebeb180652f0adf493f7227

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.96-cp311-cp311-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 1ecaf7facd6459e0404578b24b96501cc44af0c5268b9d611ecd1ca187a495cf
MD5 39814e6f3bd1d81cd22a51f267ed006c
BLAKE2b-256 e2c9157188c25335d33d2c91641bb28cb89078d6338850469b41976e1d69ebf6

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.96-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 e459d1b2ab06addaa885a7468ad3c481f5bc424011ab97547cb5d3f6d906a4ea
MD5 3f84503e3bf307137e50ce7fcb1b488a
BLAKE2b-256 cbd026115a9ba707b7b7840530c0da27f30d5b80d77d321b179af4f8c8a73a89

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.96-cp310-cp310-win32.whl
Algorithm Hash digest
SHA256 ca27ca952c1f0af39a0ceccdf91a47d4af9ecb5d5c5d0e87b58828e3bc971565
MD5 f5fe708c8c914d2c9abaf7d00e86ee9f
BLAKE2b-256 3f1f7ffc86239dee730cea9ad4ccaf8bde4f74692751354d7a5fb42770f60d23

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.96-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 bd450032297aca4ca594239ad4e6033a8fae441b38ed623b8cdb6c0c34819b61
MD5 727965ab8f0e50cbebfe042a6829daba
BLAKE2b-256 5caf16581b63fba046479848f3bbd7874194da727e95519d075c81efa9221182

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.96-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm Hash digest
SHA256 bd8ec17b00f4d7d9242a527e865a9c333e908f1a81cce0186a99f5c28dd69e24
MD5 2b76c49b5ff1f487ba64219f3a5e8669
BLAKE2b-256 34c9e659fe263575c1dd3c2e85cfd1274a9338eb46f4082d1395cb5578c7b0b1

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.96-cp310-cp310-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 9586c8255e06d4eeb67adafdc2ddda5b11ea8069e471e665b0cd5f1a4834beb3
MD5 878e5530ba6a4cb98a40c097884216fe
BLAKE2b-256 4ee610db67bbb7e48780005e6625160aff4e1cb8750cddb5a6bf09187fb58851

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.96-cp39-cp39-win_amd64.whl
Algorithm Hash digest
SHA256 71e335d0b09554d52b76847f20fce2fd4eeb5cc855f35df4795285cb9c44a697
MD5 9082fc22412893268a7c2c70e21533fb
BLAKE2b-256 d5b7b8a4d1264e0cfab64db24b4b599893ea021b26142366d29244ff479bcdab

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.96-cp39-cp39-win32.whl
Algorithm Hash digest
SHA256 9595ac16c47cf00c60c42573164274b35bf3227115e47a067f2ef86c3ca527b4
MD5 798c2c956fc702cd740794ff11ab3b73
BLAKE2b-256 dae63c49abd612cae26d89ddbb9051b7bf4e95e096a67896d31c77b3fcf4cf59

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.96-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 478c6566952c37b1566f1d40de122ab7da167e05da992560c8f7800b7fc1baa1
MD5 da02b7db3e1fe2cefe3d41d98c11e7d0
BLAKE2b-256 89eea99ac1d128b9b160f3748e902d191edd12077a2a92b98f848213f00e7427

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.96-cp39-cp39-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm Hash digest
SHA256 83aa49e80c585fa44f5ca08a9e15a2253c42629205b447f64729ee04e4d53d58
MD5 8fe8aec0154568d04b02da790ac5735e
BLAKE2b-256 6f0659df26cbf2950eff20a3e7a3d37f615053d41d29974a772c16e572c01d23

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.96-cp39-cp39-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 acc20eb5e102232740bb8be1ad42fa6f6820ea578b54a00846e9af2b490f9cbf
MD5 f6a7fd76a75bf2d40b326941dc224b7f
BLAKE2b-256 c4d4177b48335c4f1f20fb28b77b5773071523306e533edf57c6a988bf935e7a

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.96-cp38-cp38-win_amd64.whl
Algorithm Hash digest
SHA256 ec14e566ea941711692913bf227db4509920b98911a9fd827154346521c9ef3b
MD5 375dd1db663c52db818237abcc0b323b
BLAKE2b-256 02a82c17e1fbee66ec3ae864fe7f447e566c8ab02eca852190d858e96000cb53

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.96-cp38-cp38-win32.whl
Algorithm Hash digest
SHA256 9008791449139b0d14dbee23932cc76ee4d793068f86b34acdbc7545f79e01d4
MD5 e7699f20f4c08d4e14e71f6d2a2a48c8
BLAKE2b-256 7dbb71cc024172cee6006c93e2c20d2642afe0adcd7e93a5943a03e06197b1dc

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.96-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 9a60b47f9109dda98acdc2ae216d93ed1a7a7b7a18cf8ec38d5ccd52d264bf95
MD5 7c41c8aa44cf01b49e56acae2fbff7e8
BLAKE2b-256 b9412c1a80ce871725eef4d832844f7437338efe9ad37d21b6ab6e0bc99c879d

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.96-cp38-cp38-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm Hash digest
SHA256 7860b715d2eea0bed27dab8b0d6839f3bf0796ba54d81d464273507137905787
MD5 b49a39dc388cd97509769717a57c36f9
BLAKE2b-256 c2f16275b683b6fcbe277d88fea6fbca0dae8478b55f2ed03c4a884482fe2582

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.96-cp38-cp38-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 4c9e298afbfb790b0c1369096142c1f67fbc3c0a3989e850d984ec6077b9594e
MD5 bd7327d473cb236731b5dba8f4f68774
BLAKE2b-256 66385426cc444ded2435b02b9f5bb37e0b173ec1726bf3aee2fde878f1c2abe3

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