Skip to content

Commit 3e1d2cc

Browse files
Issue 407 (#439)
* creating requirements-dev.txt for pip instalation * Adding section about installing dependencies with pip
1 parent c36d581 commit 3e1d2cc

3 files changed

Lines changed: 48 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ Switched to a new branch '386'
8080

8181
### 7. Execute o brutils Localmente
8282

83-
#### Instalação
83+
#### Instalação com poetry
8484

8585
##### Requisitos
8686

@@ -117,6 +117,28 @@ Installing dependencies from lock file
117117
...
118118
```
119119

120+
#### Instalação com pip
121+
122+
Se preferir usar pip, você pode instalar o projeto em modo de desenvolvimento da seguinte forma:
123+
124+
##### Requisitos
125+
126+
- [Python 3.8+][python]
127+
- [pip][pip]
128+
129+
Crie um [virtualenv][virtualenv] para o brutils e o ative através do comando:
130+
131+
```sh
132+
python -m venv venv
133+
source venv/bin/activate # No Windows use: venv\Scripts\activate
134+
```
135+
136+
Utilize o comando pip para instalar as dependencias de dev e testes através do arquivo requirements-dev.txt
137+
138+
```sh
139+
pip install -r requirements-dev.txt
140+
```
141+
120142
#### Utilizando Localmente
121143

122144
Agora você pode usá-lo [da mesma forma descrita no arquivo README.md](/README.md#utilização).

CONTRIBUTING_EN.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Switched to a new branch '386'
7575

7676
### 7. Run brutils locally
7777

78-
## Installation
78+
## Installation with poetry
7979

8080
### Requirements
8181

@@ -112,6 +112,28 @@ Installing dependencies from lock file
112112
...
113113
```
114114

115+
## Installation with pip
116+
117+
If you prefer to use pip, you can install the project in development mode as follows:
118+
119+
### Requirements
120+
121+
- [Python 3.8+][python]
122+
- [pip][pip]
123+
124+
Create a [virtualenv][virtualenv] for brutils and activate it using the following command:
125+
126+
```sh
127+
python -m venv venv
128+
source venv/bin/activate # On Windows use: venv\Scripts\activate
129+
```
130+
131+
Use the pip command to install the dev and test dependencies through the requirements-dev.txt file:
132+
133+
```sh
134+
pip install -r requirements-dev.txt
135+
```
136+
115137
## Using locally
116138

117139
Now, you can use it [in the same way described in the README.md file](/README_EN.md#usage).

requirements-dev.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
ruff>=0.5.0,<0.7.0
2+
coverage>=7.2.7

0 commit comments

Comments
 (0)