Skip to content

Commit

Permalink
remove extras
Browse files Browse the repository at this point in the history
  • Loading branch information
ZanSara committed Oct 10, 2023
1 parent d6f0cbe commit a096ff8
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 19 deletions.
15 changes: 5 additions & 10 deletions README.md
Expand Up @@ -33,23 +33,18 @@ Canals powers version 2.0 of the [Haystack framework](https://github.com/deepset

## Installation

Running:
To install Canals, run:

```console
pip install canals
```

gives you the bare minimum necessary to run Canals.

To be able to draw pipelines, please make sure you have either an internet connection (to reach the Mermaid graph renderer at `https://mermaid.ink`) or [graphviz](https://graphviz.org/download/) (version 2.49.0) installed and then install Canals as:

### Mermaid
```console
pip install canals[mermaid]
```
To be able to draw pipelines (`Pipeline.draw()` method), please make sure you have either an internet connection (to reach the Mermaid graph renderer at `https://mermaid.ink`) or [graphviz](https://graphviz.org/download/) (version 2.49.0) installed. If you
plan to use Mermaid there is no additional steps to take, while for graphviz
you need to do:

### GraphViz
```console
sudo apt install graphviz # You may need `graphviz-dev` too
pip install canals[graphviz]
pip install pygraphviz
```
10 changes: 1 addition & 9 deletions pyproject.toml
Expand Up @@ -25,18 +25,10 @@ classifiers = [
dynamic = ["version"]
dependencies = [
"networkx", # Pipeline graphs

"requests", # Mermaid diagrams
]

[project.optional-dependencies]
graphviz = [
"pygraphviz", # Draw pipelines (requires the 'graphviz' system library)

]
mermaid = [
"requests", # Draw pipelines (requires internet connectivity)

]
dev = [
"hatch",
"pre-commit",
Expand Down

0 comments on commit a096ff8

Please sign in to comment.