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 hashes)

Uploaded CPython 3.11 Windows x86-64

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

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 hashes)

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 hashes)

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 hashes)

Uploaded CPython 3.11 macOS 10.9+ x86-64

testghacookiecutter-0.0.100-cp310-cp310-win_amd64.whl (55.3 kB view hashes)

Uploaded CPython 3.10 Windows x86-64

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

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 hashes)

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 hashes)

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 hashes)

Uploaded CPython 3.10 macOS 10.9+ x86-64

testghacookiecutter-0.0.100-cp39-cp39-win_amd64.whl (55.3 kB view hashes)

Uploaded CPython 3.9 Windows x86-64

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

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 hashes)

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 hashes)

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 hashes)

Uploaded CPython 3.9 macOS 10.9+ x86-64

testghacookiecutter-0.0.100-cp38-cp38-win_amd64.whl (55.1 kB view hashes)

Uploaded CPython 3.8 Windows x86-64

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

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 hashes)

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 hashes)

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 hashes)

Uploaded CPython 3.8 macOS 10.9+ x86-64

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