From 3e1d2cc3a51b382a7c8450bcc30072201aab10f2 Mon Sep 17 00:00:00 2001 From: FloraSauerbronn <130789651+FloraSauerbronn@users.noreply.github.com> Date: Thu, 19 Dec 2024 16:17:05 -0300 Subject: [PATCH] Issue 407 (#439) * creating requirements-dev.txt for pip instalation * Adding section about installing dependencies with pip --- CONTRIBUTING.md | 24 +++++++++++++++++++++++- CONTRIBUTING_EN.md | 24 +++++++++++++++++++++++- requirements-dev.txt | 2 ++ 3 files changed, 48 insertions(+), 2 deletions(-) create mode 100644 requirements-dev.txt diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 756e0891..02365193 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -80,7 +80,7 @@ Switched to a new branch '386' ### 7. Execute o brutils Localmente -#### Instalação +#### Instalação com poetry ##### Requisitos @@ -117,6 +117,28 @@ Installing dependencies from lock file ... ``` +#### Instalação com pip + +Se preferir usar pip, você pode instalar o projeto em modo de desenvolvimento da seguinte forma: + +##### Requisitos + +- [Python 3.8+][python] +- [pip][pip] + +Crie um [virtualenv][virtualenv] para o brutils e o ative através do comando: + +```sh +python -m venv venv +source venv/bin/activate # No Windows use: venv\Scripts\activate +``` + +Utilize o comando pip para instalar as dependencias de dev e testes através do arquivo requirements-dev.txt + +```sh +pip install -r requirements-dev.txt +``` + #### Utilizando Localmente Agora você pode usá-lo [da mesma forma descrita no arquivo README.md](/README.md#utilização). diff --git a/CONTRIBUTING_EN.md b/CONTRIBUTING_EN.md index 18ed1000..995a4bca 100644 --- a/CONTRIBUTING_EN.md +++ b/CONTRIBUTING_EN.md @@ -75,7 +75,7 @@ Switched to a new branch '386' ### 7. Run brutils locally -## Installation +## Installation with poetry ### Requirements @@ -112,6 +112,28 @@ Installing dependencies from lock file ... ``` +## Installation with pip + +If you prefer to use pip, you can install the project in development mode as follows: + +### Requirements + +- [Python 3.8+][python] +- [pip][pip] + +Create a [virtualenv][virtualenv] for brutils and activate it using the following command: + +```sh +python -m venv venv +source venv/bin/activate # On Windows use: venv\Scripts\activate +``` + +Use the pip command to install the dev and test dependencies through the requirements-dev.txt file: + +```sh +pip install -r requirements-dev.txt +``` + ## Using locally Now, you can use it [in the same way described in the README.md file](/README_EN.md#usage). diff --git a/requirements-dev.txt b/requirements-dev.txt new file mode 100644 index 00000000..533b5971 --- /dev/null +++ b/requirements-dev.txt @@ -0,0 +1,2 @@ +ruff>=0.5.0,<0.7.0 +coverage>=7.2.7