Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

How to add dependencies in more detail #1021

Merged
merged 6 commits into from
Nov 1, 2023
Merged

How to add dependencies in more detail #1021

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f849dea
How to add dependencies in more detail
simonw Oct 30, 2023
c027d96
Update docs/environment.md
simonw Nov 1, 2023
8ac941e
Update docs/environment.md
simonw Nov 1, 2023
d2ba547
Update docs/environment.md
simonw Nov 1, 2023
c43763c
Update docs/environment.md
simonw Nov 1, 2023
80df654
Merge branch 'master' into patch-1
simonw Nov 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion docs/environment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,17 @@ hatch run test -VV

Hatch ensures that environments are always compatible with the currently defined [project dependencies](config/metadata.md#dependencies) (if [installed](config/environment/overview.md#skip-install) and in [dev mode](config/environment/overview.md#dev-mode)) and [environment dependencies](config/environment/overview.md#dependencies).

For example, add `cowsay` as a dependency then try to run it:
To add `cowsay` as a dependency, open `pyproject.toml` and add it to the [`dependencies`](config/metadata.md#dependencies) array:

```toml tab="pyproject.toml"
[project]
...
dependencies = [
"cowsay"
]
```

This dependency will be installed the next time you [spawn a shell](#entering-environments) or [run a command](#command-execution). For example:

```console
$ hatch run cowsay -t "Hello, world!"
Expand All @@ -92,6 +102,9 @@ Syncing dependencies
|| ||
```

!!! note
The `Syncing dependencies` status will display temporarily when Hatch updates environments in response to any dependency changes that you make.

## Selection

You can select which environment to enter or run commands in by using the `-e`/`--env` [root option](cli/reference.md#hatch) or by setting the `HATCH_ENV` environment variable.
Expand Down