Installation¶
Stable release¶
To install datalight as user, run this command in your terminal:
$ pip install -U datalight --user
This is the preferred method to install datalight, as it will always install the most recent stable release.
If you don’t have pip installed, this Python installation guide can guide you through the process.
Warning
This method IS NOT AVAILABLE for alpha and beta version! Use the installation from source.
From sources¶
The sources for datalight can be downloaded from the Github repository.
the easiest way to install from the source is done by executing the following command:
pip3 install -U https://github.com/LightForm-group/datalight/archive/master.zip --user
You can either clone the public repository:
$ git clone https://github.com/LightForm-group/datalight
Or download the tarball:
$ curl -OL https://github.com/LightForm-group/datalight/tarball/master
$ tar xvf master -C datalight --strip-components=1
Once you have a copy of the source, you can install it with:
$ cd datalight-master
$ python setup.py install --user
The installer should take care of the missing dependencies, if any.
Note
on MacOS X, the downloaded file may be uncompressed automatically. In this case go to the directory were the code is and write:
pip3 install -U . --user
Warning
The option --user
will install datalight in the user directory
without the need to be administrator or root on the system.
Installing in the user directoy prevents breaking any system-wide packages.
To do this you may need to manually add the your user binary directory
to your PATH
.
On Linux and macOS you can find the user base binary directory by running:
python -m site --user-base
and adding bin
to the end of the path returned.
For example, this will typically print ~/.local
(with ~
expanded to the absolute path to your home directory)
so you’ll need to add ~/.local/bin
to your
PATH
. You can set your PATH
permanently by modifying ~/.profile
.
echo 'PATH="${PATH}:${HOME}/Library/Python/3.7/bin"' >> ~/.bash_profile
echo 'export PATH' >> ~/.bash_profile
On Windows you can find the user base binary directory by running
py -m site --user-site
and replacing site-packages
with
Scripts
. For example, this could return
C:\Users\Username\AppData\Roaming\Python37\site-packages
so you would
need to set your PATH
to include
C:\Users\Username\AppData\Roaming\Python37\Scripts
. You can set your
user PATH
permanently in the Control Panel. You may need to log
out for the PATH
changes to take effect.