xenial (1) fades.1.gz

Provided by: fades_5-1_all bug

NAME

       fades  -  A  system  that  automatically handles the virtualenvs in the cases normally found when writing
       scripts and simple programs, and even helps to administer big projects.

SYNOPSYS

       fades  [-h][--help]  [-V][--version]  [-v][--verbose]  [-q][--quiet]  [-i][--ipython]  [-d][--dependency]
       [-r][--requirement]  [-x][--exec]  [-p  version][--python=version]  [--rm=uuid]  [--system-site-packages]
       [--virtualenv-options=options] [--pip-options=options] [--check-updates] [child_program [child_options]]

       fades can be used to execute directly your script, or put it with a #! at your script's beginning.

DESCRIPTION

       fades will automagically create a new virtualenv (or  reuse  a  previous  created  one),  installing  the
       necessary  dependencies,  and  execute  your  script inside that virtualenv, with the only requirement of
       executing the script with fades and also marking the required dependencies.

       The first non-option parameter (if any) would be then  the  child  program  to  execute,  and  any  other
       parameters after that are passed as is to that child script.

       fades  can also be executed without passing a child script to execute: in this mode it will open a Python
       interactive interpreter inside the created/reused virtualenv (taking dependencies  from  --dependency  or
       --requirement options).

OPTIONS

       -h, --help
              Show help about all the parameters and options, and quit.

       -V, --version
              Show the program version and info about the system, and quit.

       -v, --verbose
              Send all internal debugging lines to stderr, which may be very useful if any problem arises.

       -q, --quiet
              Don't  show anything (unless it has a real problem), so the original script stderr is not polluted
              at all.

       -i, --ipython
              Runs IPython shell instead of python ones.

       -d, --dependency
              Specify dependencies through command line. This option can be specified multiple times  (once  per
              dependency),  and each time the format is repository::dependency. The dependency may have versions
              specifications, and the repository is optional (defaults to 'pypi'). Examples:

                  requests
                  pypi::requests > 2.3
                  requests<=3

              See more examples below for real command line usage explanations.

       -r, --requirement
              Read the dependencies from a file. Format in each line is the  same  than  dependencies  specified
              with --dependency.

       -p version, --python=version
              Select  which Python version to be used; the argument can be just the number (2.7), the whole name
              (python2.7) or the whole path (/usr/bin/python2.7).   Of  course,  the  corresponding  version  of
              Python needs to be installed in your system.

              The  dependencies  can  be indicated in multiple places (in the Python source file, with a comment
              besides the import, in a requirementsfile, and/or  through  command  line.  In  case  of  multiple
              definitions  of the same dependency, command line overrides everything else, and requirements file
              overrides what is specified in the source code.

       -x, --exec
              Execute the child_program inside the virtualenv.

              The child_program must be found in the virtualenv's bin directory.

       --rm uuid
              Remove a virtualenv by uuid.

       --system-site-packages
              Give the virtual environment access to thesystem site-packages dir

       --virtualenv-options=VIRTUALENV_OPTION
              Extra options to be supplied to virtualenv. (this option can beused multiple times)

       --pip-options=PIP_OPTION
              Extra options to be supplied to pip. (this option can beused multiple times)

       --check-updates
              Will check for updates in PyPI to verify if there are new versions for the requested dependencies.
              If  a  new  version is available for a dependency, it will use it (if the dependency was requested
              without version) or just inform which new version is available (if the  dependency  was  requested
              with a specific version).

EXAMPLES

       fades foo.py --bar

              Executes  foo.py  under  fades,  passing the --bar parameter to the child program, in a virtualenv
              with the dependencies indicated in the source code.

       fades -v foo.py

              Executes foo.py under fades, showing all the fades messages (verbose mode).

       fades -d dependency1 -d dependency2>3.2 foo.py --bar

              Executes foo.py under fades (passing the  --bar  parameter  to  it),  in  a  virtualenv  with  the
              dependencies  indicated  in  the  source  code and also dependency1 and dependency2 (any version >
              3.2).

       fades -d dependency1

              Executes the Python interactive interpreter in a virtualenv with dependency1 installed.

       fades -r requirements.txt

              Executes  the  Python  interactive  interpreter  in  a  virtualenv  after  installing  there   all
              dependencies taken from the requirements.txt file.

USING CONFIGURATION FILES

       You   can   also   configure   fades  using  .ini  config  files.  fades  will  search  config  files  in
       /etc/fades/fades.ini, the path indicated by xdg for your system  (for  example  ~/config/fades/fades.ini)
       and .fades.ini.  So you can have different settings at system, user and project level.

       The  config  files  are  in .ini format. (configparser) and fades will search for a [fades] section.  You
       have to use the same configurations that in the CLI. The only difference is with the config options  with
       a dash, it has to be replaced with a underscore.

       Check   http://fades.readthedocs.org/en/latest/readme.html#setting-options-using-config-files   for  full
       examples.

SEE ALSO

       Development is centralized in https://github.com/PyAr/fades

       Check that site for a better explanation of fades usage.

AUTHORS

       Facundo Batista, Nicolás Demarchi (see development page for contact info).

LICENSING

       This program is free software: you can redistribute it and/or modify  it  under  the  terms  of  the  GNU
       General Public License version 3, as published by the Free Software Foundation.

                                                                                                        FADES(1)