Add short description here

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for dkempf from gravatar.com dkempf

Unverified details

These details have not been verified by PyPI
Meta
  • License: MIT License (MIT)
  • Maintainer: Your Name
  • Requires: Python >=3.8
Classifiers

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

Verified details

These details have been verified by PyPI
Maintainers
Avatar for dkempf from gravatar.com dkempf

Unverified details

These details have not been verified by PyPI
Meta
  • License: MIT License (MIT)
  • Maintainer: Your Name
  • Requires: Python >=3.8
Classifiers

Release history Release notifications | RSS feed

This version

0.0.100

0.0.99

0.0.98

0.0.97

0.0.96

0.0.95

0.0.94

0.0.93

0.0.92

0.0.91

0.0.90

0.0.89

0.0.88

0.0.87

0.0.86

0.0.85

0.0.84

0.0.83

0.0.82

0.0.81

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

Uploaded CPython 3.11 Windows x86-64

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

Uploaded CPython 3.11 Windows x86

testghacookiecutter-0.0.100-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.100-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.100-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.100-cp310-cp310-win_amd64.whl (55.3 kB view details)

Uploaded CPython 3.10 Windows x86-64

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

Uploaded CPython 3.10 Windows x86

testghacookiecutter-0.0.100-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.100-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl (79.8 kB view details)

Uploaded CPython 3.10 manylinux: glibc 2.17+ i686

testghacookiecutter-0.0.100-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.100-cp39-cp39-win_amd64.whl (55.3 kB view details)

Uploaded CPython 3.9 Windows x86-64

testghacookiecutter-0.0.100-cp39-cp39-win32.whl (50.1 kB view details)

Uploaded CPython 3.9 Windows x86

testghacookiecutter-0.0.100-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.100-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.100-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.100-cp38-cp38-win_amd64.whl (55.1 kB view details)

Uploaded CPython 3.8 Windows x86-64

testghacookiecutter-0.0.100-cp38-cp38-win32.whl (49.9 kB view details)

Uploaded CPython 3.8 Windows x86

testghacookiecutter-0.0.100-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.100-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.100-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.100-cp311-cp311-win_amd64.whl.

File metadata

File hashes

Hashes for testghacookiecutter-0.0.100-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 e77e2551cdcd8482faaff2819c92944c732180859bdfb246edb17a5ec48a848f
MD5 de4104922bf70912035e1a28a4cbf99c
BLAKE2b-256 969eba7a2818356bd2c8bd3a91ce375dc4240886d2d3c6b09c6eb78f55052664

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.100-cp311-cp311-win32.whl
Algorithm Hash digest
SHA256 c671c5c8fc7200e437002b8eb71f5c686fe7e6cdc608d2fb3bbd705d53c0c42c
MD5 c0ca4c04954dbace345691b5060dc1c5
BLAKE2b-256 94c7e7037bc1942bfb99be4cf4b7ecfc7a6e2de31ae7b093058a36b085cebb7c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.100-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 4800fd831e3023d73220b39907ada637829986cd94b9ed85c9db078229b3a2e3
MD5 cea89ea2c6b70f15346fb2f83419e8fb
BLAKE2b-256 5b2fd9da3d95d9a2356670c7658afc0d6534243664b7c50a95103116cf8d9b66

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.100-cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm Hash digest
SHA256 8201e7fe512a327c971dfd8ecd93566e8d628efcf3ebe607bf2c41a9e9122856
MD5 74ef384cca3f23b7c1079f7faae45670
BLAKE2b-256 9d762c0660863cc8e7c63216822379853245e1e6cc9000b824448bf55a903cb9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.100-cp311-cp311-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 5070a64d972d2ce36b0d00455ae03765f21b95e8c4413a5a1ac6b6ac892a1ce8
MD5 c788b0f03f9a8338b82caaf7620878ac
BLAKE2b-256 4a1476eddfeb230fa434a4ac2f6af1d64dd13a5582863790aa735c9ebb494553

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.100-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 2a9cd82546abee9f0d83dc64317ff334d318ce36a8c992b1bf5971f7155a60c1
MD5 dc76ee3c1e7a3b22616b35ed4d7bfccc
BLAKE2b-256 baf775646995422c136bb7e8aeef541d75ea95aa42c187d8df51e6f3a284dc1f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.100-cp310-cp310-win32.whl
Algorithm Hash digest
SHA256 f777fb705bf6e21fcdd55e5adb81f177cf70e2dc7b1e2110e215abd7f1ef1e17
MD5 e0a24b6928fa0f5bef7e729bf65fa65a
BLAKE2b-256 bd5b8b553fbefb9e6c60089b59968fbd3160cca5720f5ecad2b87e876357a014

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.100-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 a69b2611bd7b932648e37bce1d198adfe8e98070e4201b807c2536e7ae2be7db
MD5 9c1cb28dac92da888b1eaea29de2c9eb
BLAKE2b-256 0f6b920e20982d279e7b2df1cd83957b492ab991bfe033e81fb334d8d2b7ab41

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.100-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm Hash digest
SHA256 abd2ea6975823efd2fe62e3dc9630fa8618a9cc2da7b111eb671a3668309e7e3
MD5 74a8be34de8d457e0e1de3b26f07de65
BLAKE2b-256 cc92769237e50351e5178b029da8ce857e498f167c71243c1acec335bc2f8ffa

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.100-cp310-cp310-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 351ae0804ca2905d990236bda91caebc5aef60b143df414499df7414e08a0e8b
MD5 8e1d8bf622d270619832cc4166ab994f
BLAKE2b-256 7f9e01a37eaf52f2c41b9c04c8e2d8c939f59760c279a2a134850927cb44306f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.100-cp39-cp39-win_amd64.whl
Algorithm Hash digest
SHA256 0f89ae6e0cbdbe838f47a1c40d875226f658e52dc60c5cd3a961206980d5bc63
MD5 82e9a0d37cfa5b827278970d03331793
BLAKE2b-256 58fc9e382de455f191e282d9bd090e48b15d24325bb551eba9f8b5afa08473ef

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.100-cp39-cp39-win32.whl
Algorithm Hash digest
SHA256 6bb0a50cd309c7ef8c90b4c22da6f6bcbd8359266e801f5b80c1dc966a4adf6e
MD5 d0813253bce38319ee0c8cbef6f49566
BLAKE2b-256 692e0a99e400d731f41a99b7e9abb7e54e7e830a92f3ba16a415f8f2f5c05cad

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.100-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 3894b1812da50b8f97ceaf86b0a6ba7a9cd68dc46f7428e4fc92a6c7acb53d6f
MD5 5348f922fe6629eb406d28eba9487833
BLAKE2b-256 e01660cf77fa680f41a06f3f6eb16b94bc2785ef21f026a51a817c13f01ae722

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.100-cp39-cp39-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm Hash digest
SHA256 c237d72472173ecb4f72dc7c4282872beb43a0c88f79ed4cb5ca836febaeb4ab
MD5 da0def76ae54b3a9c2bdc25aef8b327a
BLAKE2b-256 938642915670e2113131db529c813f591a5dd839937bad78739e6da882013d92

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.100-cp39-cp39-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 925e21601a3b0ebed0cf4e8e67dcbed98c49296afa2e5d9c2ff96f1fb17c8418
MD5 60125a0597a06468cbadce63de90b50d
BLAKE2b-256 e4bde3f56211a09d0f86e8ff1672a36607910c200c087fa8719efd7efe83dde2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.100-cp38-cp38-win_amd64.whl
Algorithm Hash digest
SHA256 ef0dfffe7f00bf80dfeb702e55cab811ba8749d7ef17c9c340080a1c163b3e7b
MD5 e2ab24929a96bbb546ebd16232f4bf70
BLAKE2b-256 b3d5dbfafa8080a0f18fca4ab0c5d0652534ead39ea883950aece016fd98f15d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.100-cp38-cp38-win32.whl
Algorithm Hash digest
SHA256 d2850b4a98afb76ceb2f8f7a1f1d43d1721375594cb533854953f4adfe086507
MD5 42204be5b49e7383f6ed9ca2febcd5fb
BLAKE2b-256 c4e9316da043ec46e8e8a95a43253b8716d4e960ab97b1345cf0849c7be5745f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.100-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 bdf8b818eba3fa20a2512e03d15406011bb851b9e8ef0b25204af49c10e4632c
MD5 0ae2e292b2307857df703912d9500fbb
BLAKE2b-256 cbb11509ba5b751823749933f997d766f4adbfac2d89ec787b9eaf2502825456

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.100-cp38-cp38-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm Hash digest
SHA256 ee979a89af28ea3257a94bd7045fe087e9a20f17519245f60646c9f937faea65
MD5 9e2de9d752cf6665eb1304d962e7fdf1
BLAKE2b-256 2fcf1ebc5e46b5d13df660b9eea535a6daf93ae556fc9a4dd190fa3454d19547

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.100-cp38-cp38-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 76061c9e49a3a6b1bcd4186130f2241028af3d11277ca4ce2fb1b275d3edd9e1
MD5 cae9c5e737c463d72bc63d4886a0ba85
BLAKE2b-256 bb7859675f7c59ced4af90db7c850b1255e97baf76fceaf50700e3049bb6441e

See more details on using hashes here.

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