bugyi.dummy

Dummy python project used to test the cc-python cookiecutter.

Badges 📛

project status badges:

version badges:

tools / frameworks used by test suite (i.e. used by make test):

linters used to maintain code quality (i.e. used by make lint):

tools / frameworks used to render documentation (i.e used by make build-docs):

miscellaneous tools used to maintain this project:

Installation 🗹

Using pipx to Install (preferred)

This package could be installed using pip like any other Python package (in fact, see the section below this one for instructions on how to do just that). Given that we only need this package's entry points, however, we recommend that pipx be used instead:

# install and setup pipx
python3 -m pip install --user pipx
python3 -m pipx ensurepath

# install bugyi.dummy
pipx install bugyi.dummy

Using pip to Install

To install bugyi.dummy using pip, run the following commands in your terminal:

python3 -m pip install --user bugyi.dummy  # install bugyi.dummy

If you don't have pip installed, this Python installation guide can guide you through the process.

Useful Links 🔗

• API Reference: A developer's reference of the API exposed by this project.
• cc-python: The cookiecutter that was used to generate this project. Changes made to this cookiecutter are periodically synced with this project using cruft.
• CHANGELOG.md: We use this file to document all notable changes made to this project.
• CONTRIBUTING.md: This document contains guidelines for developers interested in contributing to this project.
• Documentation: This project's full documentation.