Yaptr

Yet Another Python Template Repo

A full-featured Python template repository with autogenerated docs, GitHub Action CI, Ruff, pytest, and pre-commit already configured.

Features

• pytest
• ruff
• sphinx
• pre-commit

Quickstart

1. Clone the repository

Use the template in GitHub by clicking the green "Use this template" button at the top of the page.

Alternatively:

• Click here: Use this template

Or, if using another git platform:

git clone [email protected]:YoloWingPixie/yaptr.git new-directory-name
cd new-directory-name

Replace new-directory-name with the desired name of your new project.

---

2. Run the setup script

make setup-all

• Designed to be cross-platform.
• Windows users: Run this command from PowerShell or Windows Terminal.
• This command installs dependencies for both frontend and backend.

---

3. Select a license

You will be prompted to select a license for your project:

• Refer to choosealicense.com for more details about licenses.
• If unsure, it's recommended to select: 5) Copyright (All Rights Reserved)

---

4. Remove the license folder

After selecting a license, you will be prompted to delete the /license folder:

• Consider removing the choose-license script from the Makefile to continue using the make setup-all command in the future without being prompted for a license.

---

5. Reset Sphinx documentation

Run the following command to reset the Sphinx documentation:

make reset-sphinx

---

Changelog

The changelog for the project is based on Keep a Changelog