Skip to content

Commit 6c30a5b

Browse files
authored
update installation instructions in README
* suggest `pip install -e .` instead of editing the PYTHONPATH and PATH environment variables (which does not work nicely in Windows and/or VSCode) * suggest venv instead of `--user` * suggest `pip` instead of `pip3` (Python2 is not supported anyway) * delete details about the C++11 compiler for ufal.udpipe
1 parent c321cfe commit 6c30a5b

1 file changed

Lines changed: 7 additions & 11 deletions

File tree

README.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,27 +7,23 @@ Python framework for processing Universal Dependencies data
77

88
## Requirements
99
- You need Python 3.9 or higher.
10-
- If the [ufal.udpipe](https://pypi.python.org/pypi/ufal.udpipe/) parser is needed,
11-
make sure you have a C++11 compiler (e.g. [g++ 4.7 or newer](.travis.yml#L9))
12-
and install UDPipe with `pip3 install --user --upgrade ufal.udpipe`.
10+
- It is recommended to install Udapi in a Python virtual environment.
11+
- If you need the [ufal.udpipe](https://pypi.python.org/pypi/ufal.udpipe/) parser (to be used from Udapi)
12+
install it (with `pip install --upgrade ufal.udpipe`).
1313

1414
## Install Udapi for developers
15-
Let's clone the git repo to `~/udapi-python/`, install dependencies
16-
and setup `$PATH` and `$PYTHONPATH` accordingly.
15+
Let's clone the git repo e.g. to `~/udapi-python/` and make an [editable installation](https://setuptools.pypa.io/en/latest/userguide/development_mode.html)
1716
```bash
1817
cd
1918
git clone https://github.com/udapi/udapi-python.git
20-
pip3 install --user -r udapi-python/requirements.txt
21-
echo '## Use Udapi from ~/udapi-python/ ##' >> ~/.bashrc
22-
echo 'export PATH="$HOME/udapi-python/bin:$PATH"' >> ~/.bashrc
23-
echo 'export PYTHONPATH="$HOME/udapi-python/:$PYTHONPATH"' >> ~/.bashrc
24-
source ~/.bashrc # or open new bash
19+
cd udapi-python
20+
pip install -e .
2521
```
2622

2723
## Install Udapi for users
2824
This is similar to the above, but installs Udapi from PyPI to the standard (user) Python paths.
2925
```
30-
pip3 install --user --upgrade udapi
26+
pip install --upgrade udapi
3127
```
3228
Try `udapy -h` to check it is installed correctly.
3329
If it fails, make sure your `PATH` includes the directory where `pip3` installed the `udapy` script.

0 commit comments

Comments
 (0)