♻️ Generate more of the same stuff
Project description
⚡ Features
makemore
generates more of the same stuff.
📦 How to install
pdm add makemore
💻 Example Usage
📚 Code Guidelines and Project Layout
Please check the documentation.
🤗 Contributing
Development
- Clone the repository:
# using github cli
gh repo clone baggiponte/makemore
# using git (SSH recommended)
git clone git@github.com:baggiponte/makemore
Note
🎬 How to configure SSH
Cloning over SSH is safer. Follow this guide. Alternatively, you can follow the steps in this workshop of GitHub's.
- Install
pdm
:
pipx install pdm
Warning
🔎 Why
pipx
?pip install --user
is not recommended, as it does not ensure dependency isolation. For this purpose, the Python Packaging Authority (PyPA) advises to usepipx
.pipx
installs and runs python CLIs in isolated environments. To install it, follow the instructions here.
- Install production and development dependencies.
The recommended approach is to use just
. Install just
with your favourite package manager, then run the following:
just setup
Alternatively, run the following:
pdm install --dev
pdm run pre-commit install --install-hooks
Before submitting a PR
Run the following:
just pre-release
just test
The following operations will be performed:
- Format with
black
andisort
. - Lint with
ruff
. - Run type checks with
mypy
. - Audit dependencies with
pip-audit
. - Check commit messages are consistent with Conventional Commits using
commitizen
. - Check whether a version bump is possible.
- Run all tests.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.