• Workshop platform
  • Table of Contents
  • Prerequisites
  • Installation
  • Adding a New Package
  • Adding a Development Package

Before you begin, ensure you have met the following requirements:

• Python (>= 3.11)
• Poetry (for managing dependencies and building the project)

To install the project and its dependencies, follow these steps:

1. Clone the repository:

   git clone https://github.com/your-username/your-project.git
   cd your-project

2. Install Poetry (if not already installed):

   pip install poetry

   Set up the project using Poetry:

   poetry install

   This will install all the required dependencies.

3. Install pre-commit

   poetry run pre-commit install

   This will install pre-commit hooks to run before each commit. If any of the hooks fail, the commit will be aborted.

1. Open a terminal and navigate to your project's root directory, where your pyproject.toml file is located.
2. Use Poetry's add command to add a new package as a runtime dependency. Replace package-name with the name of the package you want to add:

   poetry add package-name

Development packages are dependencies that are only required during development, such as testing libraries or code formatting tools. Here's how to add a development package:

1. Open a terminal and navigate to your project's root directory, where your pyproject.toml file is located.
2. Use Poetry's add command with the --dev flag to add a package as a development dependency. Replace dev-package-name with the name of the development package you want to add:

   poetry add --group dev dev-package-name

3. To install all development dependencies (useful for continuous integration or other developers working on your project), you can run:

   poetry install --no-root