Pyg’s config files¶
New in version 0.4.
Config files allow you to override command-line options, and to save them somewhere. During the initialization process, Pyg looks for configurations file, it this order:
./pyg.conf
: a configuration file in the current working directory:~/pyg.conf
: where~
stands for yourHOME
directory;~/.pyg/pyg.conf
.
A config file has this structure:
[section_name]
option = value
[section_name2]
option1 = value1
option2 = value2
...
In addition to this, Pyg supports a nonstandard syntax, allowing multiple section names in a single header:
[section1 & section2 & section6]
option = value
It will set that option in all specified sections.
Note: If you set an option to False
, false
, or 0
, Pyg will consider it as false.
The global
section¶
New in version 0.7.
This section is a special one: there is no global
command, and it refers to Pyg’s global options.
At the moment there is only one global option: --no-colors
. You can set it as follows:
[global]
no_colors = True
Example usage¶
Example 1¶
~/pyg.conf
:
[remove]
yes = True
[install]
upgrade_all = True
Pyg:
$ pyg install iterutils
Loading options from ~/pyg.conf
iterutils is already installed, upgrading...
Looking for iterutils releases on PyPI
Best match: iterutils==0.1.6
Downloading iterutils [100% - 2.9 Kb]
Checking md5 sum
Running setup.py egg_info for iterutils
Running setup.py install for iterutils
iterutils installed successfully
$ pyg remove iterutils
Loading options from ~/pyg.conf
Uninstalling iterutils
/usr/local/lib/python2.7/dist-packages/iterutils.py
/usr/local/lib/python2.7/dist-packages/iterutils.pyc
/usr/local/lib/python2.7/dist-packages/iterutils-0.1.6-py2.7.egg-info
Deleting: /usr/local/lib/python2.7/dist-packages/iterutils.py
Deleting: /usr/local/lib/python2.7/dist-packages/iterutils.pyc
Deleting: /usr/local/lib/python2.7/dist-packages/iterutils-0.1.6-py2.7.egg-info
Removing egg path from easy_install.pth...
iterutils uninstalled succesfully
Example 3¶
You can also override saved options from the command line.
pyg.conf
:
[install]
index_url = http://pypi.python.org/pypi
Pyg:
$ pyg install itertools_recipes -U --index-url = http://pypi.python.org/simple
itertools_recipes is already installed, upgrading...
Looking for links on http://pypi.python.org/simple
Found: itertools_recipes-0.1.tar.gz
Downloading itertools_recipes [100% - 2.3 Kb]
Running setup.py egg_info for itertools_recipes
Running setup.py install for itertools_recipes
itertools_recipes installed successfully
instead of:
$ pyg install -U itertools_recipes
itertools_recipes is already installed, upgrading...
Looking for itertools_recipes releases on PyPI
Best match: itertools_recipes==0.1
Downloading itertools_recipes [100% - 2.3 Kb]
Checking md5 sum
Running setup.py egg_info for itertools_recipes
Running setup.py install for itertools_recipes
itertools_recipes installed successfully
Option tree¶
Here is a list of all sections and their default options:
global:
- no_colors = False
install:
- upgrade = False
- upgrade_all = False
- no_deps = False
- index_url =
http://pypi.python.org/pypi
- install_dir =
pyg.locations.INSTALL_DIR
- user = False
- no_scripts = False
- ignore = False
remove:
- yes = False
bundle:
- exclude = None
update:
- yes = False
download:
- unpack = False
- download_dir =
.
- prefer = None
freeze:
- count = False
- file = None
unlink:
- all = False