Skip to content

Commit

Permalink
Change optional dependency instruction
Browse files Browse the repository at this point in the history
  • Loading branch information
StijnKas committed Dec 11, 2024
1 parent 54d5177 commit 8472f06
Showing 1 changed file with 3 additions and 9 deletions.
12 changes: 3 additions & 9 deletions examples/articles/GettingStarted.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -32,17 +32,11 @@
"If you do not have Python or no compatible version installed, `uv` will automatically install a compatible version.\n",
"\n",
"## Optional dependencies\n",
"As of V4 of pdstools, we have made a big effort to reduce the number of big and heavy core dependencies. This means that while initial installation is very fast, you may at some points run into import errors and will be required to install additional dependency groups. If using `uv`, these can be installed with the `--extra` argument. \n",
"As of V4 of pdstools, we have made a big effort to reduce the number of big and heavy core dependencies. This means that while initial installation is very fast, you may at some points run into import errors and will be required to install additional dependency groups. \n",
"\n",
"For instance, to install the optional dependencies to use the Pega DX API client, you should run \n",
"\n",
"```bash\n",
"uv pip install pdstools --extra api\n",
"```\n",
"\n",
"The alternative (pip-compatible) syntax for optional dependencies is:\n",
"To install extra dependencies, you can put them in square brackets after a package name. So, for instance, to install pdstools alongside the optional dependencies for the Pega DX API client, you should run:\n",
"```bash\n",
"pip install 'pdstools[api]'\n",
"uv pip install 'pdstools[api]'\n",
"```\n",
"\n",
"For an overview of all optional dependencies and the dependency groups they will be installed for, see the table below:\n",
Expand Down

0 comments on commit 8472f06

Please sign in to comment.