Skip to content

Commit 2479737

Browse files
committed
Fixes from review
1 parent 04984bc commit 2479737

File tree

1 file changed

+10
-23
lines changed

1 file changed

+10
-23
lines changed

README.md

Lines changed: 10 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,6 @@ In order to use this tool, your system needs to fulfill the following prerequisi
5454

5555
* Software
5656
* Linux
57-
* [bash](https://www.gnu.org/software/bash/) >= 4.2
5857
* Python3 >= 3.10
5958
* [Docker](https://docs.docker.com/) >= 17.05
6059
* with support for [multi-stage builds required](https://docs.docker.com/develop/develop-images/multistage-build/)
@@ -71,17 +70,22 @@ Further, prerequisites might be necessary for specific tasks. These are listed u
7170

7271
### Installation
7372

74-
#### PyPi - recommend
73+
In general, it's good practice to install the package in a virtual environment, using `venv` or `Poetry`.
7574

76-
```
75+
#### Pip via PyPi
76+
77+
```commandline
7778
python3 -m pip install exasol-script-languages-container-tool
7879
```
7980

80-
#### From Github release
81+
#### Pipx via Pypi
8182

82-
Find the wheel package for a specific [release](https://github.com/exasol/script-languages-container-tool/releases) under assets.
83+
If you plan to use `exasol-script-languages-container-tool` on the command line only via the `exaslct` script, we suggest the installation via `pipx`:
84+
85+
```commandline
86+
pipx install exasol-script-languages-container-tool
87+
```
8388

84-
Install the python package with `python3 -m pip install https://github.com/exasol/script-languages-container-tool/releases/download/$VERSION/exasol_script_languages_container_tool-$VERSION-py3-none-any.whl`. Replace $VERSION with the latest version or the specific version you are interested in.
8589

8690
### Usage
8791

@@ -135,23 +139,6 @@ ALTER SESSION SET SCRIPT_LANGUAGES='<LANGUAGE_ALIAS>=localzmq+protobuf:///<bucke
135139
* Can push Docker images to Docker registries
136140
* Run tests for you container against an Exasol DB (docker-db or external db)
137141

138-
## Limitations
139-
140-
* Caution with symbolic links:
141-
If you use symbolic links inside any directory of the command line arguments
142-
they must not point to files or directories outside the root of the path of the
143-
command line argument (i.e. --flavor-path ./flavors/my_flavor/ => There must be no symbolic
144-
link inside ./flavors/my_flavor point to anywhere outside of ./flavors/my_flavor).
145-
Background: Local directories paths must be mounted manually to the docker container.
146-
We currently support only the mounting of the given command line arguments, but we do not analyze
147-
the content of those directories.
148-
Plan is to fix this limitation with [#35](https://github.com/exasol/script-languages-container-tool/issues/35)
149-
150-
151-
### MacOsX Limitations
152-
153-
* On MacOsX all arguments (flavors path, output directory, etc.) must point to locations within the current directory (background is that the MacOsX version does not support mount binding additional directories).
154-
155142
## Table of Contents
156143

157144
### Information for Users

0 commit comments

Comments
 (0)