Pip Package with C++ Backend Template

This is a template project for future pip package project with an optional C/C++ backend.

Components

Essential

• pipcpptemp_src: Source file of the package, will be usable only after compilation. _src is added as a suffix to avoid Python mixing up the source folder before compilation and the package folder after compilation.
• pyproject.toml: Define the essential info and metadata on PyPI of a pip package.
• setup.py: Define the packages by name and path, and extensions by their build command.
• MANIFEST.in: Define what files will be distributed. Remember to include C++ source/header to ensure successful compilation.

Optional

• example: The scripts serve as examples for other users. Remember to include a requirements.txt if the examples require any dependencies.
• dev: The scripts for development use which you do not expect users to read, or test scripts for you to see whether the package is working.
• README.md: The poster of this package. Please make sure it's elegant since it will be illustrated on project mainpage of Github or PyPI.
• LICENSE: License file, without this other researchers will not be able to redistribute your code. MIT license is recommended for academic usage, which only asks others to retain your authorship.

Useful Command

Some useful commands are packed into bash scripts in the root folder.