buff

Table of Contents

• Prerequisites
• Setting Up the Development Environment
• Code Formatting and Linting

Prerequisites

• Python 3.11 (recommended; or newer)
• Poetry for dependency management.

Setting Up the Development Environment

1. Clone the Repository:

   git clone https://github.com/punitarani/buff.git
   cd buff

2. Install Dependencies using Poetry:

   poetry install

   Poetry should automatically create a virtual environment for you. If it doesn't, you can initiate one manually:

   poetry shell

3. Setup Environment Variables:

   • Copy the .config/.env.template to .env in the root directory.
   • Fill out the necessary environment variables in the .env file.

4. Setup Pre-commit Hooks: Use the provided Makefile to set up the necessary pre-commit hooks:

    make setup

Code Formatting and Linting

• Format Code:

  make format

• Lint Code:

  make lint