Add short description here

These details have not been verified by PyPI

Project description

Welcome to My C++ Project

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

These details have not been verified by PyPI

Release history Release notifications | RSS feed

0.0.100

Jan 1, 2024

0.0.99

Dec 1, 2023

0.0.98

Nov 1, 2023

0.0.97

Oct 1, 2023

0.0.96

Sep 1, 2023

0.0.95

Aug 1, 2023

0.0.94

Jul 1, 2023

0.0.93

Jun 1, 2023

0.0.92

May 1, 2023

0.0.91

Apr 1, 2023

0.0.90

Mar 1, 2023

0.0.89

Feb 1, 2023

0.0.88

Jan 1, 2023

0.0.87

Dec 1, 2022

This version

0.0.86

Nov 1, 2022

0.0.85

Oct 1, 2022

0.0.84

Sep 1, 2022

0.0.83

Aug 1, 2022

0.0.82

Jul 7, 2022

0.0.81

Jul 7, 2022

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

Uploaded Nov 1, 2022 CPython 3.10 Windows x86-64

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

Uploaded Nov 1, 2022 CPython 3.10 Windows x86

testghacookiecutter-0.0.86-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (72.3 kB view details)

Uploaded Nov 1, 2022 CPython 3.10 manylinux: glibc 2.17+ x86-64

testghacookiecutter-0.0.86-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl (77.9 kB view details)

Uploaded Nov 1, 2022 CPython 3.10 manylinux: glibc 2.17+ i686

testghacookiecutter-0.0.86-cp310-cp310-macosx_10_9_x86_64.whl (44.7 kB view details)

Uploaded Nov 1, 2022 CPython 3.10 macOS 10.9+ x86-64

testghacookiecutter-0.0.86-cp39-cp39-win_amd64.whl (55.8 kB view details)

Uploaded Nov 1, 2022 CPython 3.9 Windows x86-64

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

Uploaded Nov 1, 2022 CPython 3.9 Windows x86

testghacookiecutter-0.0.86-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (72.7 kB view details)

Uploaded Nov 1, 2022 CPython 3.9 manylinux: glibc 2.17+ x86-64

testghacookiecutter-0.0.86-cp39-cp39-manylinux_2_17_i686.manylinux2014_i686.whl (78.3 kB view details)

Uploaded Nov 1, 2022 CPython 3.9 manylinux: glibc 2.17+ i686

testghacookiecutter-0.0.86-cp39-cp39-macosx_10_9_x86_64.whl (44.8 kB view details)

Uploaded Nov 1, 2022 CPython 3.9 macOS 10.9+ x86-64

testghacookiecutter-0.0.86-cp38-cp38-win_amd64.whl (55.8 kB view details)

Uploaded Nov 1, 2022 CPython 3.8 Windows x86-64

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

Uploaded Nov 1, 2022 CPython 3.8 Windows x86

testghacookiecutter-0.0.86-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (72.2 kB view details)

Uploaded Nov 1, 2022 CPython 3.8 manylinux: glibc 2.17+ x86-64

testghacookiecutter-0.0.86-cp38-cp38-manylinux_2_17_i686.manylinux2014_i686.whl (77.8 kB view details)

Uploaded Nov 1, 2022 CPython 3.8 manylinux: glibc 2.17+ i686

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

Uploaded Nov 1, 2022 CPython 3.8 macOS 10.9+ x86-64

File details

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

File metadata

Download URL: testghacookiecutter-0.0.86-cp310-cp310-win_amd64.whl
Upload date: Nov 1, 2022
Size: 56.0 kB
Tags: CPython 3.10, Windows x86-64
Uploaded using Trusted Publishing? No
Uploaded via: twine/4.0.1 CPython/3.9.15

File hashes

Hashes for testghacookiecutter-0.0.86-cp310-cp310-win_amd64.whl
Algorithm	Hash digest
SHA256	`934021bcd932bd40a1f65a4162e0e706c9dfc2823c6848bed1b9bc285780ca19`
MD5	`85c6e59250fec5a0758ea73702b4b9bc`
BLAKE2b-256	`5ac7f85747e22cfea768230e51c63cacb861ef0c044d59124ad27fce88afc80c`

Algorithm	Hash digest
SHA256	`96b6105dda3952074a1734e4515b52fa7f375691c4824b418fe36ec00990572a`
MD5	`5d8eb9f9e394268c94f39b98aeb65bf7`
BLAKE2b-256	`4a63d6640dea4221bffc346f19ac1c21d5b280b60a9dec1afeab2d0fdb78388c`

Algorithm	Hash digest
SHA256	`f19b8a116ff39821d5f82a6148f2581d8fd6c31295c4ac0e41ca7794d0dad194`
MD5	`513ea96b6cfe0f5c9a93e568f6a29940`
BLAKE2b-256	`58c8b71e70fcbba545b7ac3f58f173ec78208ea7a8fbef8fad2516058a60ca7e`

Algorithm	Hash digest
SHA256	`98df26c871ff97e0ae430a2a5a9c826f58b625472eee485d90f2940a919cad4b`
MD5	`90af277c2cd65230b2f5a2362635225e`
BLAKE2b-256	`8b915211b093626678d8c2cc8b0d1ee0f69eec6a03b043676aefb9dd9c8647f4`

Algorithm	Hash digest
SHA256	`793032eeaef76f821747061c437f78c2f95d13e1931168b52a04b5f0dc7afd84`
MD5	`659a8ec59e9ba1e31be194042d4dc68b`
BLAKE2b-256	`f8bc5a3b1c10a1d43b0ca2469c52e3ac5e58810faf22844ff86b3bc4086656fd`

Algorithm	Hash digest
SHA256	`8880896d1d8781ee5d6b865e68dd81199cc1b93ce5bdc616b042087f88efa961`
MD5	`e4129c6cd5694bc19237748d34bfecd2`
BLAKE2b-256	`04d0d0becc8872876df8c7ee161e976f6b0a7257cd14b996507d10b77e9a034e`

Algorithm	Hash digest
SHA256	`dfef2adaec193c7927ea65cd56850abdf60e41ecd9ddca16d029dc2dadda6b29`
MD5	`d4ed29337fbdbc877ea3c1cfcc6a074c`
BLAKE2b-256	`c00f2e535f3b65bdea1b6b44456498d41cce61a8f166d3394e7a31ff6313ddd9`

Algorithm	Hash digest
SHA256	`ff1a11af625baee99f932c12d0eea530b25c5f72b6c2a7697d17668c7253c32a`
MD5	`3f07a859ed2a4f9401eca437d182f7fb`
BLAKE2b-256	`c986548c7e4512da17b33a7bebbbe9c26d83795c12a34fbcf0d28432a414c4f9`

Algorithm	Hash digest
SHA256	`47a721cfcabf15693986125860a46561715079708a35d783b91fb6bef4cd7dd9`
MD5	`48b88d991550c2388b699205b3ac1411`
BLAKE2b-256	`0db12a701310dfe1aedff64ad94e8cb8db5db1a4c7bcb5d97d097f1fcc3141d1`

Algorithm	Hash digest
SHA256	`c7d0f3203a02de1708ce895b827681e2fe0a3b186e3bbfe0dd3f43e1ee2e7338`
MD5	`2a8e92977fb94cd1d3f66beedbe4d3b9`
BLAKE2b-256	`b40d97c51ddb2d882eb79d89e9093230cf4490621befffbc2c85fa846a141903`

Algorithm	Hash digest
SHA256	`0feb2c526716459cf57bbf2bec9685e0967e45e6eedd173e92f45d08864e9992`
MD5	`84c968b75705bca8b7435892e8a8b739`
BLAKE2b-256	`321e842d415aa7bc046236a01e23d0b01a94288c199986b10a1e4095b15c6002`

Algorithm	Hash digest
SHA256	`e5a47118771411983db97b2f91c604400ce44d3a9fdccdb32969bd59a8615c6b`
MD5	`cc053ec8053964ff4ba3650b56c58e7c`
BLAKE2b-256	`5b9ad11bcdb5034d2afafbc9f558fee071b61d6759233a13845007d1aaffc4fe`

Algorithm	Hash digest
SHA256	`6bda8634ecfb9ebae745431a6763f96b7152ed11f37bf695ba71aae1a448e00d`
MD5	`688ab767d5fdd8d6ea0e3bbd4f78c8fe`
BLAKE2b-256	`5d7061db3ef7cad97a34bd8baed3e1d23c1c5f60fbcb48fc205e71e3286f365c`

Algorithm	Hash digest
SHA256	`c7ae47a182c9397d2d0eeca7f2129a585cbcd814b6b1c7d9ed78805cc553911b`
MD5	`6969af59a77ade4bf35e05a242b39599`
BLAKE2b-256	`0d5d9c53f3a0195ecc98e9a9c2e2817f3a031be0a55f0f2101111bb15c4905cb`

Algorithm	Hash digest
SHA256	`1367de33d630ee2dc32b49af4dc95b7a0c2daa012232b73b17c16c18db16f0b9`
MD5	`43a95df06d96a39a0f491da65b6afd78`
BLAKE2b-256	`001df83388a7fac4d81c7c5159c1ee85a6b1edf56837bd4a4deeff2af00ddfb2`

testghacookiecutter 0.0.86

Navigation

Verified details

Maintainers

Unverified details

Meta

Classifiers

Project description

Welcome to My C++ Project

Prerequisites

Building My C++ Project

Testing My C++ Project

Documentation

Project details

Verified details

Maintainers

Unverified details

Meta

Classifiers

Release history Release notifications | RSS feed

Download files

Source Distributions

Built Distributions

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details