makemore 0.1.7

♻️ Generate more of the same stuff

♻️ Makemore

⚡ 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

1. Clone the repository:

# using github cli
gh repo clone baggiponte/makemore

# using git (SSH recommended)
git clone [e-mail]: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.

2. 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 use pipx. pipx installs and runs python CLIs in isolated environments. To install it, follow the instructions here.

3. 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:

1. Format with black and isort.
2. Lint with ruff.
3. Run type checks with mypy.
4. Audit dependencies with pip-audit.
5. Check commit messages are consistent with Conventional Commits using commitizen.
6. Check whether a version bump is possible.
7. Run all tests.