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

Uploaded CPython 3.11 Windows x86-64

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

Uploaded CPython 3.11 Windows x86

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

Uploaded CPython 3.10 Windows x86-64

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

Uploaded CPython 3.10 Windows x86

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

Uploaded CPython 3.9 Windows x86-64

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

Uploaded CPython 3.9 Windows x86

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

Uploaded CPython 3.8 Windows x86-64

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

Uploaded CPython 3.8 Windows x86

testghacookiecutter-0.0.98-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.98-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.98-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.98-cp311-cp311-win_amd64.whl.

File metadata

File hashes

Hashes for testghacookiecutter-0.0.98-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 c11ad370a9c5e61fa188d6c99a2de7e2bbbd3fb68b2f6ed38f313cd846e11a19
MD5 c589a133251f0957b23b3d828d3684d3
BLAKE2b-256 fb7544199fa59015461af61f423f560d5708fe6ec99c6dada1d4ae50d0613f76

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.98-cp311-cp311-win32.whl
Algorithm Hash digest
SHA256 75c98aac61c086c5fee260ebd2e97aebf7accfe2b20bae9bf87c0e1ac73a4a2f
MD5 135634a9b2705e6ce76c68d5d2279b49
BLAKE2b-256 f324d502d16f00be83bd2e42c45c3a7a447a1c289248d11b8498cb332736da51

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.98-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 4834cb1dd100a8896330f2fb8e42bd8fc031cf3cd693f34857a3ee1d5d29b29e
MD5 200ad88393f8aa26c8a979c13fde2b70
BLAKE2b-256 54b828aba91c8f9b87b0fafcc5f6072ddde944463c8f01ee3bf30489b94fa08b

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.98-cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm Hash digest
SHA256 879f2c7d3c754387809275c3226e6456213d248f8b6564fa1124dfc68735bb84
MD5 6ec1f06c648e3a9fdb0f56ae0bfa0d6c
BLAKE2b-256 03e9767bdc25c04a139a7b911dfd18b273deabce77074572bc0801d872696ea3

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.98-cp311-cp311-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 c6fca702942d2024e013ae842e67f4ecdc0cdff2aa10abf5e106673a97495318
MD5 adc7203f9ba273d259acd01a90c3f9f8
BLAKE2b-256 8e939ca75683da49a617c895df2726d549a49db355e26cc663017ab9141927ef

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.98-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 19e7093fb416c9aa400125cbe31a95e5a40ea45c5756eb046055a000dbf04259
MD5 08f356429c2295fb6b953dd38aae051c
BLAKE2b-256 866f9cfe2be8de6aff30eb0ed0786c0126ae0d62908b2afbf3a47536f1b82648

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.98-cp310-cp310-win32.whl
Algorithm Hash digest
SHA256 8df1f3b28d6435fdafb4dd07e1a4563e192597d030aacb0321f5026c2a26320d
MD5 7353d20ef46fc66024d95b92df362854
BLAKE2b-256 5b15d9cc4f5226b93884bd547aad48528c50a5fb75443e536894e129644fd1c6

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.98-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 f06a09e16fe1ca27bc93a2578a84ddc9c224973d2e097ec5d1f52c8d2ed6052d
MD5 d82a665bc23461d644bd1c86abfa07a3
BLAKE2b-256 8c34e1af4c39841e850160f19db2967ca787dfdc653c4c1345147d2c11a67c3e

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.98-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm Hash digest
SHA256 be24edd7b101059172dd4c127222916c360032335e813cf79d6efed5fefb4308
MD5 6cc73d75c96247a3d465f72d82189644
BLAKE2b-256 3d73904a293248a7ac3ccbb7163e47bd0fb690f638754ef5bcc62b94ed6d8cdf

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.98-cp310-cp310-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 3ed2a250e5b29fe6b855d7bfbf5b536ecc6f8855f52f4bb9948ec497b4cc3311
MD5 9fd507b00abfdd6110edfc8fc3335254
BLAKE2b-256 68b64b67cdcc9363ab99562fbbb489579975531b372a77d97b2f6a3f3371bbad

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.98-cp39-cp39-win_amd64.whl
Algorithm Hash digest
SHA256 de5191ced9eef7a234a1c67de2ff7513a668a190c245f9f02bdbf14d6c8c7478
MD5 fb55ada6bf94f77626e653b678642add
BLAKE2b-256 059693a696fb3e7ee108884b982e77a141e459678eb6ad062aa7f179bcbf0027

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.98-cp39-cp39-win32.whl
Algorithm Hash digest
SHA256 31a7c8ec6daf361f58a5834e5a8d551fd44dfa98588ab7a98238259f50406c99
MD5 28c9a5cb16c5194c0059c5627e6c56db
BLAKE2b-256 0057366586a6e367c291ebc5c99e58190bc342bfc4055231cf1e17500b3b424b

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.98-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 bb0d9f508ac392ed1c34f3e1d08d8a61a4f7a110a2de80595eda39d37fd706ae
MD5 ca17d5567c725f57c0d1537ba9550723
BLAKE2b-256 dc041a3285ac4d67bcd3f1542d402f03fa8916a13e2fb41da0bd4351eb0d5005

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.98-cp39-cp39-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm Hash digest
SHA256 efddd3dbb0b4507eca60069da8c9beefbabe5321b9c32987e9adc314cc48bc7a
MD5 61325d95a1ba369e3ec3f154056c7047
BLAKE2b-256 5d71f694d62e46432e9aaf42f6ed19bd6098cb894037a3e41f29f5a951bcaefc

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.98-cp39-cp39-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 45b5ddddb27a10721d3d90a45a309daeefb9a93d9b31e96d9d7c8055080f444c
MD5 cb7fd1e477cd1833d39f74ee6e665a8b
BLAKE2b-256 39becf65110b2ea009ae4954d5b9dd3385b65f6010c2afa1525a590e1c8a9267

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.98-cp38-cp38-win_amd64.whl
Algorithm Hash digest
SHA256 ccfdf24f8b04341f25dd62ce9448701c3892c9c90211b390e52b0a1b97d48fe2
MD5 5de3f3f57afc3d971d0e0edecbe3f3fd
BLAKE2b-256 655c28472f39b391ebc8393ce1777ef66a65235733d6596c1dd17ca5bd9ac9e9

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.98-cp38-cp38-win32.whl
Algorithm Hash digest
SHA256 cf6fef86278921c94b85373e9f16607ee5b19464dcd2e4fba43c3a77014e1b77
MD5 d762a0de6364922693f87bef75446e77
BLAKE2b-256 d833916b51d1198f8dac2d9e8010acd33c610a774bf10f611635dd5b80b8288d

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.98-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 9d89f2ea29bb2c6f6f05833fd826ed6b681b1ecbcb190a37f67fa9fa1c7fc297
MD5 ed71a112807b31508c32856f909f6b06
BLAKE2b-256 6c1f9aebda96a1cb00553fd70efe35bdaf9c781d3904a026cb2a7aab63ae129e

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.98-cp38-cp38-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm Hash digest
SHA256 48666b6a2d3f437fb99b81b2e8fb9eea1f1ad359ad8b391420b06f3ba59fdc84
MD5 b65855d957ee7498a41bb1cd1f939043
BLAKE2b-256 3597aac3e84c65bc54b3adcd1ebe135ec43ea37fad4b6d8c0df87512516183ea

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.98-cp38-cp38-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 c54e5ee801f75043193b75252576ca0d30862b93d7e187ad28f9212709f9768d
MD5 bd5b5030cf8b63f90fbf8aab7febda73
BLAKE2b-256 b16c51c352cdf57c983e4ad362a50167f2447c1f5eec3ac03247f2e4c0c8ab10

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