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

Improve poetry setup steps #24

Merged
merged 3 commits into from
Oct 18, 2023
Merged

Improve poetry setup steps #24

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f76ea03
Add poetry setup steps
Oct 16, 2023
b04088c
Remove poetry add from setup
Oct 16, 2023
dc9dd6d
Update README.md
jhidding Oct 18, 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
16 changes: 14 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,16 @@ We’re trying to increase the visibility of Entangled. If you like Entangled, p
```

## Get started
To install Entangled, all you need is a Python installation. If you use [`poetry`](https://python-poetry.org),
To install Entangled, all you need is a Python (version ≥3.11) installation. If you use [`poetry`](https://python-poetry.org), and you start a new project,

```
poetry init
poetry add entangled-cli
```

Or, if you prefer `pip`,
The `poetry init` command will create a `pyproject.toml` file and a virtual environment to install Python dependencies in. To activate the virtual environment, run `poetry shell` inside the project directory.

Or, if you prefer plain old `pip`,

```
pip install entangled-cli
Expand Down Expand Up @@ -126,6 +129,15 @@ The `identifiers` are the tags that you may use in your code block header to ide
And so on...
~~~

If you have a `pyproject.toml` file, either because you use `poetry` to setup Entangled or because you're actually developing a Python project, you may want to put the configuration in `pyproject.toml` instead. Add a section `tools.entangled` like so:

```toml
[[tools.entangled]]
version = "2.0"
watch_list = ["docs/**/*.md"]
```


### Using the `build` hook

:::warning
Expand Down