Skip to content

Commit

Permalink
Create basic_poetry_usage.md
Browse files Browse the repository at this point in the history
  • Loading branch information
framunoz authored Nov 7, 2024
1 parent 7d2203e commit 4d45b11
Showing 1 changed file with 48 additions and 0 deletions.
48 changes: 48 additions & 0 deletions doc/basic_poetry_usage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Basic ```poetry``` usage

This short tutorial is a summary of the official ``poetry``
documentation. For more information, see the
[official documentation](https://python-poetry.org/docs/basic-usage/).

## Adding a dependency

When you want to add a new dependency to the project, you can run the
following command:

```bash
poetry add <DEPENDENCY>
```

Where `<DEPENDENCY>` is the name of the dependency you want to add.

In case you want to add a development dependency, you can run the following

```bash
poetry add --dev <DEPENDENCY>
```

## Installing dependencies

To install the dependencies of the project, you can run the following command:

```bash
poetry install
```

## Activating the virtual environment

To activate the virtual environment, you can run the following command:

```bash
poetry shell
```

## Running a script

To run a script, you can use the following command:

```bash
poetry run <SCRIPT>
```

Where `<SCRIPT>` is the name of the script you want to run.

0 comments on commit 4d45b11

Please sign in to comment.