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

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

This version

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

Uploaded CPython 3.10 Windows x86-64

testghacookiecutter-0.0.83-cp310-cp310-win32.whl (51.4 kB view details)

Uploaded CPython 3.10 Windows x86

testghacookiecutter-0.0.83-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (72.2 kB view details)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64

testghacookiecutter-0.0.83-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl (77.8 kB view details)

Uploaded CPython 3.10 manylinux: glibc 2.17+ i686

testghacookiecutter-0.0.83-cp310-cp310-macosx_10_9_x86_64.whl (44.6 kB view details)

Uploaded CPython 3.10 macOS 10.9+ x86-64

testghacookiecutter-0.0.83-cp39-cp39-win_amd64.whl (55.7 kB view details)

Uploaded CPython 3.9 Windows x86-64

testghacookiecutter-0.0.83-cp39-cp39-win32.whl (51.5 kB view details)

Uploaded CPython 3.9 Windows x86

testghacookiecutter-0.0.83-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (72.6 kB view details)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64

testghacookiecutter-0.0.83-cp39-cp39-manylinux_2_17_i686.manylinux2014_i686.whl (78.2 kB view details)

Uploaded CPython 3.9 manylinux: glibc 2.17+ i686

testghacookiecutter-0.0.83-cp39-cp39-macosx_10_9_x86_64.whl (44.7 kB view details)

Uploaded CPython 3.9 macOS 10.9+ x86-64

testghacookiecutter-0.0.83-cp38-cp38-win_amd64.whl (55.6 kB view details)

Uploaded CPython 3.8 Windows x86-64

testghacookiecutter-0.0.83-cp38-cp38-win32.whl (51.4 kB view details)

Uploaded CPython 3.8 Windows x86

testghacookiecutter-0.0.83-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (72.1 kB view details)

Uploaded CPython 3.8 manylinux: glibc 2.17+ x86-64

testghacookiecutter-0.0.83-cp38-cp38-manylinux_2_17_i686.manylinux2014_i686.whl (77.7 kB view details)

Uploaded CPython 3.8 manylinux: glibc 2.17+ i686

testghacookiecutter-0.0.83-cp38-cp38-macosx_10_9_x86_64.whl (44.7 kB view details)

Uploaded CPython 3.8 macOS 10.9+ x86-64

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.83-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 8274e4d3f11bf66ebfb792237f94524cef3950e998d6bf85c74d92803e4f2696
MD5 719c08f0f4cb2bce9c75b3880019146f
BLAKE2b-256 2ce965972590e807b7964132327eb79791a5b79fa93d15e0b355242afb613b15

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.83-cp310-cp310-win32.whl
Algorithm Hash digest
SHA256 2a5e25bfcde7386eb4fc4a750a96448258a00345a243ba2b028e1a1cd6f967c3
MD5 0d046c89ef656a4975d17d8fb4a4ed32
BLAKE2b-256 c8a892d63d2178381035f81df9f6998358203a7390dcdaac077c5ca3070cef9f

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.83-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 bed1742528bd3cd0be22141f51420afe8dbe93992da684079635aa5cc1102191
MD5 3ec6b25c0598636901551f32a4f88fe6
BLAKE2b-256 876659cb356ecf07f6dd02bd74353be56a07a82ac251a4f26a327257a2166831

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.83-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm Hash digest
SHA256 93b99816c9fab1d6480aa4acd512f8b42110eb5cf54a836c6a07b152d06d8cc9
MD5 c5ab4cca559ad6616f437eade60c04d6
BLAKE2b-256 3be7c5121842639eaf1acb11483d39ce4bbd5c8c1b2b149be8f3e5f660613424

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.83-cp310-cp310-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 07848c54bca748395bf19a88fa9506baafe059cf46c127ec3c65f0dc7cdfb009
MD5 68f240bf96459bff65e617da2d9f68cc
BLAKE2b-256 a329ca50ea1bbb3a63cd05fba7721f04b0dce3510768b9bffae198b5a82ec15d

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.83-cp39-cp39-win_amd64.whl
Algorithm Hash digest
SHA256 832d800b0b4a3ae005604a6f48a17c98a80a382a2b49e1f3c89a3cb6c2e2caaa
MD5 20fa8d48579806e23067323b727b6d6f
BLAKE2b-256 d55ad53db95f39d8008c5cf402c26d4552fb535036b9d048970de09644f0a7c2

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.83-cp39-cp39-win32.whl
Algorithm Hash digest
SHA256 5dcd0ed17f48478a5a7278a27fb4229d90b1dac2ff6758085742ed6f1a633281
MD5 7d81f84b41ea82553ceca7e5f9c822f8
BLAKE2b-256 3f84e930b903d2614df32927dcdc3f92ac495b362b1831c31680c928731ee4ef

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.83-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 809a4da3b9740fae63f2b9b0e292056a7393bd06ce37dc7e41259aebae899611
MD5 c843f77127e1255e4ee830ffe8690631
BLAKE2b-256 e95d474cbe5e67f93945044f28e83a2fb29ce5a08efa7d0c14f2d6ed995ad175

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.83-cp39-cp39-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm Hash digest
SHA256 b4929e5257d24f4696a694eea9a9170337932fac8ab7107b314cd21f42f86388
MD5 29863b319e9bbee352a2f0d3ca613c60
BLAKE2b-256 dd9e6eb480c382fc0d872cc6622d03ea6ebf8316cfe923e76164b69c883fc5ca

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.83-cp39-cp39-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 495e6d7b8ab5898b2cb93aecd1a6ecaeec96a7095701591e8430f372d1663cb3
MD5 697d9f6813c3ef6f95c5ffefd1228fb7
BLAKE2b-256 d09ace7c02eef228358d3ccbabbe08a16db05bd9efb056f6809477ac290b0ec6

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.83-cp38-cp38-win_amd64.whl
Algorithm Hash digest
SHA256 d86be40ca7ccacccde920abaeb8d66d4e6fd69324e5ad15ecf6234acc2dbf2b1
MD5 78cf53b306d9184c95835f17c17e34a0
BLAKE2b-256 1c07a6d0a2989485db523a333138c9d72f3e2fdd29f4a570de2bda686c4bbb2e

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.83-cp38-cp38-win32.whl
Algorithm Hash digest
SHA256 27b711408207311e696ef4ef134645c8d3b5fccb1833370daa301f286fd91766
MD5 7e46c3eeb6d34e8e2935b628c31e1418
BLAKE2b-256 dd6e4b6e5028a41b3fd2e15b16479bf3edbc59e1539a856e062de7d45cd9c4fa

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.83-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 dca4d732fe29c7297da9b96702a6cca96b9810f75266eb00681dc17632303bb3
MD5 bc0b59726ccb2f917c5ddbc654f6c64d
BLAKE2b-256 95e0be3c555ba06a51f141e33282eb1f5212b7f647a9eff319ffcb469bdbd433

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.83-cp38-cp38-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm Hash digest
SHA256 5a58d42d57e0b753822a06e2b65d836e78819b5bb616b515e74ee30e062fb228
MD5 9ae8c1374e7f2b5ab01e34db40dffb3f
BLAKE2b-256 d41de0b381731ca2f8412c07a270fd61b579af6bc2e5b0ea68a34277c10aaa79

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for testghacookiecutter-0.0.83-cp38-cp38-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 61f7cd88d65bfcc7be1eaa48b12b94072b0da373890dbc92c4f7da256d4aa9fd
MD5 385c0c9299a3a60ec2ee26230225b97e
BLAKE2b-256 4bbfe4c9162bcfc7b20312374d5da28ba72769b978b3cf99977fa36679b33d2e

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