# Changes between Version 23 and Version 24 of DRM4G/Installation

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

--

### Legend:

Unmodified
 v23 = DRM4G Installation = There are several ways to install **DRM4G**. There are several ways to install the **DRM4G**. == With pip == The recommended way to install DRM4G is by using the command pip install drm4g. The recommended way to install the ''DRM4G'' is by using the command pip install drm4g. To check if you have this tool installed just open a terminal and execute which pip. If you have it installed you'll see something like this: * 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. Once you've made sure you have pip installed, just run one of the following commands: [=#pipInstallOptions]Once you've made sure you have pip installed, just run one of the following commands: * '''With root access''': You can go ahead and run sudo pip install drm4g * '''Without root access''': Run pip install drm4g --user * '''In a [https://virtualenv.pypa.io/en/stable/  virtual environment]''': Just run pip install drm4g Bear 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. === Install in custom directory === #customInstall 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. 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. The installation command would have to be: }}} This will install your binary files and libraries under the specified path, but DRM4G will still not be able to run. This will install your binary files and libraries under the specified path, but ''DRM4G'' will still not be able to run. * 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. * 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. * 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. * 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. During 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. Once that has been taken care of, you can download the source code from [[https://pypi.python.org/pypi/drm4g|here]]. After you extract the package, in a terminal, head into the folder and run: [=#noPipInstallOptions]After you extract the package, in a terminal, head into the folder and run: * '''With root access''':  sudo python setup.py install * '''In a [https://virtualenv.pypa.io/en/stable/  virtual environment]''':  python setup.py install Bear in mind that you can extract the package in some other directory and then indicate the __setup.py's__ path to the command. === Install in custom directory === \\ == Optional Environment Variables == Optional Environment Variables == DRM4G uses the following environment variables: ''DRM4G'' uses the following environment variables: * 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. * 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. * EDITOR: Select an editor to configure the resource configuration file. The nano editor will be used by default. {{{#!comment [[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.)]] [[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.)]] }}} \\ == Installing Extras 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: == Installing Extras == 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: * drm4g_autocomplete.sh bash script adds tab-completion features to drm4g. === Enabling === To enable the DRM4G command completion without installing it: To enable the ''DRM4G'' command completion without installing it: {{{#!sh source /path/to/extras/drm4g_autocomplete.sh Thus tab-completion will take effect the next time you log in. \\ == Updating the DRM4G == Whenever 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: === With pip === * While still following [#pipInstallOptions the considerations listed before], run this command: {{{#!sh pip install --upgrade drm4g }}} === Without pip === * While still following [#noPipInstallOptions the considerations listed before], run this command: {{{#!sh python setup.py update }}} Your 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]. * Changes made between releases can be seen in [wiki:DRM4G/ChangeLog our change log page].