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.88-cp310-cp310-win_amd64.whl (55.6 kB view details)

Uploaded CPython 3.10 Windows x86-64

testghacookiecutter-0.0.88-cp310-cp310-win32.whl (50.9 kB view details)

Uploaded CPython 3.10 Windows x86

testghacookiecutter-0.0.88-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (72.0 kB view details)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64

testghacookiecutter-0.0.88-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl (77.6 kB view details)

Uploaded CPython 3.10 manylinux: glibc 2.17+ i686

testghacookiecutter-0.0.88-cp310-cp310-macosx_10_9_x86_64.whl (44.5 kB view details)

Uploaded CPython 3.10 macOS 10.9+ x86-64

testghacookiecutter-0.0.88-cp39-cp39-win_amd64.whl (55.5 kB view details)

Uploaded CPython 3.9 Windows x86-64

testghacookiecutter-0.0.88-cp39-cp39-win32.whl (51.0 kB view details)

Uploaded CPython 3.9 Windows x86

testghacookiecutter-0.0.88-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (72.4 kB view details)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64

testghacookiecutter-0.0.88-cp39-cp39-manylinux_2_17_i686.manylinux2014_i686.whl (77.9 kB view details)

Uploaded CPython 3.9 manylinux: glibc 2.17+ i686

testghacookiecutter-0.0.88-cp39-cp39-macosx_10_9_x86_64.whl (44.6 kB view details)

Uploaded CPython 3.9 macOS 10.9+ x86-64

testghacookiecutter-0.0.88-cp38-cp38-win_amd64.whl (55.5 kB view details)

Uploaded CPython 3.8 Windows x86-64

testghacookiecutter-0.0.88-cp38-cp38-win32.whl (50.9 kB view details)

Uploaded CPython 3.8 Windows x86

testghacookiecutter-0.0.88-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (71.9 kB view details)

Uploaded CPython 3.8 manylinux: glibc 2.17+ x86-64

testghacookiecutter-0.0.88-cp38-cp38-manylinux_2_17_i686.manylinux2014_i686.whl (77.4 kB view details)

Uploaded CPython 3.8 manylinux: glibc 2.17+ i686

testghacookiecutter-0.0.88-cp38-cp38-macosx_10_9_x86_64.whl (44.5 kB view details)

Uploaded CPython 3.8 macOS 10.9+ x86-64

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.88-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 099a6c5dda84cb0b94d346dadc10fcc9d45f85ff1e2bc6007a006892f0a86183
MD5 624fd734be1d65b5ab36850ea947a54e
BLAKE2b-256 0c3d7dc887c12d46705803e9301d2e0372727eaff185c7baba8f8f82d92f7070

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.88-cp310-cp310-win32.whl
Algorithm Hash digest
SHA256 93bf09377c1f7e7e5d0c51c166735c25948ead7078d83d1659dfd539679c5a82
MD5 8deb05cd1c4c4e94f8dec70b60d87f2c
BLAKE2b-256 3b2f7e4d80be296ffc6640bc4307bb0d2a8223a1ae2d3aabf2a4b29f6104a14d

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.88-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 03454c585656754219e10f31af00ac336dbb49fa06d1f625f5c4b1df9ea9be3a
MD5 1bfbb46a3c80bd7c4368ce77cc0b1206
BLAKE2b-256 330431c4c665209d1202df27b2965895f25c65bc53248ab013253857255a1aa0

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.88-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm Hash digest
SHA256 4d052789813a7d01d4d7244168a31c607a6015a49c9205e8b3781893e514cf70
MD5 e8648bb1e6cd296d5df697da8c74a775
BLAKE2b-256 08d5461beca5ece3a1d6732408a1b8f3fcaf86fedbc3a5c49b414444d44e1183

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.88-cp310-cp310-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 2d48cd9410a3f05ac0582d71901e2d3a1d2af6d003b9e725f316ea9c59dc3fd0
MD5 52094a8c5d13a3921e1eeba1d60e1eac
BLAKE2b-256 df9225a180469598aedabe2347626291b3a8695307216232a81eb821c705fc57

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.88-cp39-cp39-win_amd64.whl
Algorithm Hash digest
SHA256 8615401326907941676a71f2ad96758d18606f6ff685d925b407795f765eb5b6
MD5 13fc24fb1769ce71ee0b07c0918fc4bc
BLAKE2b-256 a2b40e74c586230d6249166682003a6e9f16a187e4a69b1569db3b037d8fe2a0

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.88-cp39-cp39-win32.whl
Algorithm Hash digest
SHA256 77bd345b43ae05f2073631a5221ca78c0909ec046b3c9929def54bbcf853be5f
MD5 0522db986f8295fb3b6bc28a23450071
BLAKE2b-256 a1fe64fa6f610d339fc5845fb813e5fc331be06b224f8fcfb7f5fbfbbd253434

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.88-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 d34cb6c0a9e677c010386e47678b03f71abf7d764a6320edc41b1457e498ea50
MD5 f63fc87a65290c7fdc5bd4608ba02e92
BLAKE2b-256 b3edd9ff239ad2e3a41a3e93408f1ada80306b3d2d61f1ccbccd7f79905c5996

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.88-cp39-cp39-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm Hash digest
SHA256 b5380bfbd7beb75b7b41b97aba07af56101ebb7927f262176130284e32bf549f
MD5 c955012e829917faf22467a16e63c922
BLAKE2b-256 7b0a3c922c51d11ef36ae0ca5f63db6d67ef9d4eb7b61629d0ac344e8b85f1ae

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.88-cp39-cp39-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 ff13a05edbe33c9faee4f01b5944d7a27e5630f9ed40357731d7f32270d74313
MD5 c978e7f898c65b130457a3c844b20cf9
BLAKE2b-256 f18d1cc3511ec4d0e630893d3197b5168a2c749a7ccfab3d8fcd7b77297ceccd

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.88-cp38-cp38-win_amd64.whl
Algorithm Hash digest
SHA256 7f834946e6f910799b5780303760841aa2785506948ef68514f5aafbcb59147c
MD5 938fcc3111729c6837314ff28d343a75
BLAKE2b-256 652f66aa1d7395d12549f29639a5d0b0358320b54433aaccc07e611403b821a0

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.88-cp38-cp38-win32.whl
Algorithm Hash digest
SHA256 0a3225039519e7d0ad593580b2b97a7a41fa972c7d842b028932e7fa8a3b6f35
MD5 9bc8a29c3d3456b99e51774451395b4f
BLAKE2b-256 4c98b71c296603615f2f317952a51e3db33b71ffbe73a8d35462a44a21a2a4ce

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.88-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 ed8a1d856fc343d04a66b8eda4e3faadd991c24efde8ce22c2e2128575d5ff3e
MD5 41963ea4a237e0926da82fba53c558c7
BLAKE2b-256 5f36619ea1e8a7c16bfe31b536efdad8c49461fefcad7b281d38f9e54ca06431

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.88-cp38-cp38-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm Hash digest
SHA256 54b916a329e90c20be9ad5b6d5ccb23f30ae2cd6cfc098f10fc6fe18634d5a13
MD5 33bf459c5700242e968bd572996eb4c0
BLAKE2b-256 4113dc2cacab2ec192acc4fecb0dee04b9c6f3a704b78a4c2d73d8582645816d

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.88-cp38-cp38-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 76d544d3a8eecd53e3261e9865ddbb6db162b6cd40359e986784156d499ad791
MD5 041e31a7b6cf0d3a90472937510f7e40
BLAKE2b-256 9bf78ae16e92a24ac15fb8c47ac7e8d62b14845c3c4d7109fa42d67f91bef454

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