Changeset 1448


Ignore:
Timestamp:
Oct 18, 2013 11:27:26 AM (9 years ago)
Author:
jemian
Message:

simplify startup of pvMail by installing launcher via setup.py task

Location:
pvMail
Files:
8 edited

Legend:

Unmodified
Added
Removed
  • pvMail/doc/source/cli.rst

    r802 r1448  
    11.. $Id$
    22
    3 pvMail.py: command-line interface
     3pvMail: command-line interface
    44==================================
    55
     
    1313background daemon::
    1414
    15         pvMail.py triggerPV messagePV user1@email.domain,user2@host.server &
     15        pvMail triggerPV messagePV user1@email.domain,user2@host.server &
    1616
    1717GUI::
    1818
    19         pvMail.py triggerPV messagePV user1@email.domain,user2@host.server -g &
     19        pvMail triggerPV messagePV user1@email.domain,user2@host.server -g &
    2020
    2121PvMail uses Matt Newville's `PyEpics <http://cars9.uchicago.edu/software/python/pyepics3/>`_
     
    3232PvMail is started from the command line::
    3333
    34         $ ./pvMail.py pvMail:trigger pvMail:message jemian
     34        $ pvMail pvMail:trigger pvMail:message jemian
    3535
    3636.. index:: log file
     
    130130.. index:: example
    131131
    132 Here is a command to run the PvMail and get the help message::
    133 
    134         /APSshare/epd/rh5-x86_64/bin/python /APSshare/epd/demos/pvMail.py -h
     132Here is a command to run PvMail and get the help message::
     133
     134        /APSshare/epd/rh5-x86_64/bin/pvMail -h
    135135
    136136or the 32-bit version::
    137137
    138         /APSshare/epd/rh5-x86/bin/python /APSshare/epd/demos/pvMail.py -h
     138        /APSshare/epd/rh5-x86/bin/pvMail -h
    139139
    140140..      note::
     
    157157When PvMail is started from the command line with no additional parameters::
    158158
    159         $ pvMail.py
    160        
    161         usage: pvMail.py [-h] [-l LOG_FILE] [-i LOGGING_INTERVAL]
     159        $ pvMail
     160       
     161        usage: pvMail [-h] [-l LOG_FILE] [-i LOGGING_INTERVAL]
    162162                         [-r SLEEP_DURATION] [-g] [-v]
    163163                         trigger_PV message_PV email_addresses
    164         pvMail.py: error: too few arguments
     164        pvMail: error: too few arguments
    165165
    166166This is the *usage* message.
     
    210210::
    211211
    212         $ pvMail.py --version
     212        $ pvMail --version
    213213        3.0-663
    214214
     
    218218It may be easier to review the short help instructions for command-line options::
    219219
    220         $ ./pvMail.py --help
    221         usage: pvMail.py [-h] [-l LOG_FILE] [-i LOGGING_INTERVAL]
     220        $ ./pvMail --help
     221        usage: pvMail [-h] [-l LOG_FILE] [-i LOGGING_INTERVAL]
    222222                         [-r SLEEP_DURATION] [-g] [-v]
    223223                         trigger_PV message_PV email_addresses
     
    251251program output to a log file.  If a LOG_FILE is not specified on the command
    252252line, the default file will be ``pvMail-PID.log`` in the current directory
    253 where *PID* is the process identifier of the running pvMail.py program.
     253where *PID* is the process identifier of the running ``pvMail`` program.
    254254
    255255..      note::
  • pvMail/doc/source/glossary.rst

    r1094 r1448  
    3030    EPICS process variable
    3131
     32:index:`PvMail`
     33    Name of the Python package that provides the ``pvMail`` executable
     34
     35:index:`pvMail`
     36    Name of the ``pvMail`` executable
     37
    3238:index:`PyEpics`
    3339    Python package to manage connections with PVs served by an EPICS IOC
  • pvMail/doc/source/gui.rst

    r802 r1448  
    33.. _GUI:
    44
    5 pvMail.py: graphical user interface
     5pvMail: graphical user interface
    66====================================
    77
     
    1515command-line interface is started.::
    1616
    17         $ ./pvMail.py -g &
     17        $ pvMail -g &
    1818
    1919..      tip::
  • pvMail/doc/source/index.rst

    r1094 r1448  
    55
    66http://subversion.xray.aps.anl.gov/admin_bcdaext/pvMail
     7
     8.. note:: While *PvMail* is the name of the Python package,
     9   the executable installed in <python>/bin is called
     10   ``pvMail`` using a command line such as::
     11   
     12   [user@host,518,~]$ pvMail
    713
    814PvMail was built to watch (monitor) an EPICS PV and send an email
  • pvMail/doc/source/info.rst

    r1094 r1448  
    4949============================
    5050
     51:v3.0.2:
     52    * (2013-10-18)
     53    * Simplify startup of ``pvMail`` by installing launcher as ``<python>/bin/pvMail`` as part of ``setup.py`` tasks
     54
    5155:v3.0.1:
    5256    * (2012-09-07)
  • pvMail/setup.py

    r681 r1448  
    3434    package_dir={'PvMail': 'src/PvMail',},
    3535    package_data = {'PvMail': ['test.db', 'LICENSE',],},
     36    entry_points={
     37        # create & install console_scripts in <python>/bin
     38        'console_scripts': pvMail.__console_scripts__,
     39    },
    3640)
  • pvMail/src/PvMail/LICENSE

    r677 r1448  
    1 Copyright (c) 2009-2012, UChicago Argonne, LLC
     1Copyright (c) 2009-2013, UChicago Argonne, LLC
    22
    33All Rights Reserved
  • pvMail/src/PvMail/pvMail.py

    r1137 r1448  
    7474__svnid__ = "$Id$"
    7575__version__ = "3"
    76 __minor_version__ = "0.1"
     76__minor_version__ = "0.2"
    7777__revision__ = __svnid__.split(" ")[2]
    7878#__full_version__ = "%s.%s-r%s" % (__version__, __minor_version__, __revision__)
     
    8484__license__ = "(c) 2009-2012, UChicago Argonne, LLC"
    8585__license__ += " (see LICENSE file for details)"
     86# create & install console_scripts in <python>/bin
     87__console_scripts__ = ['pvMail = PvMail.pvMail:main', ]
    8688
    8789LOG_FILE = "pvMail-%d.log" % os.getpid()
Note: See TracChangeset for help on using the changeset viewer.