Skip to content

Commit

Permalink
Merge branch 'main' into 395
Browse files Browse the repository at this point in the history
  • Loading branch information
camilamaia authored Dec 19, 2024
2 parents 1cea77e + 60c8937 commit 2d3335f
Show file tree
Hide file tree
Showing 4 changed files with 54 additions and 4 deletions.
24 changes: 23 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Switched to a new branch '386'

### 7. Execute o brutils Localmente

#### Instalação
#### Instalação com poetry

##### Requisitos

Expand Down Expand Up @@ -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).
Expand Down
24 changes: 23 additions & 1 deletion CONTRIBUTING_EN.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Switched to a new branch '386'

### 7. Run brutils locally

## Installation
## Installation with poetry

### Requirements

Expand Down Expand Up @@ -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).
Expand Down
8 changes: 6 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
install:
git config --local core.hooksPath .githooks/
chmod -R +x .githooks
@git config --local core.hooksPath .githooks/
# This must be indented like this, otherwise it will not work on Windows
# see: https://stackoverflow.com/questions/77974076/how-do-i-fix-this-error-when-checking-os-in-makefile
ifneq ($(OS),Windows_NT)
@chmod -R +x .githooks
endif
@poetry install

shell:
Expand Down
2 changes: 2 additions & 0 deletions requirements-dev.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
ruff>=0.5.0,<0.7.0
coverage>=7.2.7

0 comments on commit 2d3335f

Please sign in to comment.