Changes between Version 23 and Version 24 of DRM4G/Installation


Ignore:
Timestamp:
Feb 16, 2017 3:53:30 PM (5 years ago)
Author:
minondoa
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • DRM4G/Installation

    v23 v24  
    22
    33= DRM4G Installation =
    4 There are several ways to install **DRM4G**.
     4There are several ways to install the **DRM4G**.
    55
    66
    77== With pip ==
    8 The recommended way to install DRM4G is by using the command `pip install drm4g`.
     8The recommended way to install the ''DRM4G'' is by using the command `pip install drm4g`.
    99To check if you have this tool installed just open a terminal and execute `which pip`.
    1010If you have it installed you'll see something like this:
     
    1818* In the case you don't have it, follow the instructions shown in their [[https://pip.pypa.io/en/stable/installing/|documentation page]] to install it.
    1919
    20 Once you've made sure you have pip installed, just run one of the following commands:
     20[=#pipInstallOptions]Once you've made sure you have pip installed, just run one of the following commands:
    2121* '''With root access''': You can go ahead and run `sudo pip install drm4g`
    2222* '''Without root access''': Run `pip install drm4g --user`
    2323* '''In a [https://virtualenv.pypa.io/en/stable/  virtual environment]''': Just run `pip install drm4g`
    2424
     25Bear in mind that you can also download the package from [https://pypi.python.org/pypi/drm4g our PyPI page] and then indicate the it's path to the command.
    2526
    2627=== Install in custom directory === #customInstall
    2728
    28 Sometimes you will want to specify a certain directory in which to install DRM4G. To do that you'll have to take into account a couple of details.
     29Sometimes you will want to specify a certain directory in which to install ''DRM4G''. To do that you'll have to take into account a couple of details.
    2930
    3031The installation command would have to be:
     
    4243}}}
    4344
    44 This will install your binary files and libraries under the specified path, but DRM4G will still not be able to run.
     45This will install your binary files and libraries under the specified path, but ''DRM4G'' will still not be able to run.
    4546
    46 * You want your system to be aware of where the DRM4G package is, so that python may be able to import it. You'll have to define the environment variable '''PYTHONPATH''', which will have to point to the library folder under the path you chose. At the end of the installation, you'll see a message that will inform you on how to do that.
     47* You want your system to be aware of where the ''DRM4G'' package is, so that python may be able to import it. You'll have to define the environment variable '''PYTHONPATH''', which will have to point to the library folder under the path you chose. At the end of the installation, you'll see a message that will inform you on how to do that.
    4748
    48 * The next step is to have it know that DRM4G has been installed. You'll have to make sure that the directory you choose is added in your environment variable '''PATH''' or you could have it added to your '''sys.path'''. The folder we are interested in is the "''bin''" folder inside your directory.
     49* The next step is to have it know that ''DRM4G'' has been installed. You'll have to make sure that the directory you choose is added in your environment variable '''PATH''' or you could have it added to your '''sys.path'''. The folder we are interested in is the "''bin''" folder inside your directory.
    4950
    5051During the installation, you will be prompted with a question about modifying your `$HOME/.profile` or `$HOME/.bashrc` file. If you accept, you will only have to define these two environment variables the first time.
     
    7273Once that has been taken care of, you can download the source code from [[https://pypi.python.org/pypi/drm4g|here]].
    7374
    74 After you extract the package, in a terminal, head into the folder and run:
     75[=#noPipInstallOptions]After you extract the package, in a terminal, head into the folder and run:
    7576
    7677* '''With root access''':  `sudo python setup.py install`
     
    7879* '''In a [https://virtualenv.pypa.io/en/stable/  virtual environment]''':  `python setup.py install`
    7980
     81Bear in mind that you can extract the package in some other directory and then indicate the __setup.py's__ path to the command.
    8082
    8183=== Install in custom directory ===
     
    113115
    114116\\
    115 == Optional Environment Variables
     117== Optional Environment Variables ==
    116118
    117 DRM4G uses the following environment variables:
     119''DRM4G'' uses the following environment variables:
    118120
    119  * `DRM4G_DIR`: By default your configuration files will be located in `$HOME/.drm4g/`. If you wish to define where your configuration and log files will be created, before starting DRM4G with `drm4g start` you should set the environment variable '''DRM4G_DIR''' with whichever directory you wish to use, `.drm4g` will be automatically created under it.
     121 * `DRM4G_DIR`: By default your configuration files will be located in `$HOME/.drm4g/`. If you wish to define where your configuration and log files will be created, before starting ''DRM4G'' with `drm4g start` you should set the environment variable '''DRM4G_DIR''' with whichever directory you wish to use, `.drm4g` will be automatically created under it.
    120122
    121123 * `EDITOR`: Select an editor to configure the resource configuration file. The `nano` editor will be used by default.
     
    124126{{{#!comment
    125127
    126 [[NoteBox(tip, By default your configuration files will be located in `$HOME/.drm4g/`. If you wish to define where your configuration and log files will be created\, before starting DRM4G with `drm4g start` you should set the environment variable '''DRM4G_DIR''' with whichever directory you wish to use\, `.drm4g` will be automatically created under it.)]]
     128[[NoteBox(tip, By default your configuration files will be located in `$HOME/.drm4g/`. If you wish to define where your configuration and log files will be created\, before starting the ''DRM4G'' with `drm4g start` you should set the environment variable '''DRM4G_DIR''' with whichever directory you wish to use\, `.drm4g` will be automatically created under it.)]]
    127129
    128130}}}
     
    131133
    132134\\
    133 == Installing Extras
    134 Inside the DRM4G distribution package, there is a directory called "'''extras'''" that will contain scripts that can improve your experience using DRM4G. For the moment, there is only one:
     135== Installing Extras ==
     136Inside the ''DRM4G'' distribution package, there is a directory called "'''extras'''" that will contain scripts that can improve your experience using ''DRM4G''. For the moment, there is only one:
    135137
    136138 * `drm4g_autocomplete.sh` bash script adds tab-completion features to drm4g.
     
    138140=== Enabling ===
    139141
    140 To enable the DRM4G command completion without installing it:
     142To enable the ''DRM4G'' command completion without installing it:
    141143{{{#!sh
    142144source /path/to/extras/drm4g_autocomplete.sh
     
    152154Thus tab-completion will take effect the next time you log in.
    153155
     156
     157
     158
     159\\
     160== Updating the DRM4G ==
     161Whenever a new version is released, you'll want to install it. To do so the best way is to simply run one of the following:
     162
     163=== With pip ===
     164* While still following [#pipInstallOptions the considerations listed before], run this command:
     165{{{#!sh
     166pip install --upgrade drm4g
     167}}}
     168
     169
     170=== Without pip ===
     171* While still following [#noPipInstallOptions the considerations listed before], run this command:
     172{{{#!sh
     173python setup.py update
     174}}}
     175
     176Your configuration files ("__resources.conf__", "__logger.conf__", etc) won't be overwritten but some of the configuration keys in resources.conf for example might have changed so you'll have to check the [wiki:DRM4G/ResourceConfiguration resource configuration page].
     177 * Changes made between releases can be seen in [wiki:DRM4G/ChangeLog our change log page].