semvec/pypi-packages huggingface dataset:
gs_export 0.1.2
A little shell script to dump you GenericSetup profile somewhere and notify you for changes
License: BSD

GS Export
=========

GS Export is a little helper that dumps your GenericSetup profile
to a given directory, and sends you a mail, if anything has changed
since it was last run.

GS Export uses git to store the change history, it simply sends the result
of a ``git status -q`` if there are any changes.
It is your responsabilility to commit the changes, else you will get the
same notification on the next run.

GS Export always sends a passwort with each request, it is POST encoded
but it is still there. This also means, it needs basic auth working on your
plone site. You might want to run GS Export only on the same machine
as the zope client.

GS Export needs to be configured, and it needs a lot of options.
Since GS Export might be needed for many sites on one host, it does not
look for a configuration file with a fixed name, but you must provide
a configuration file as the first argument to the script.
This is a sample configuration. All arguments are required::

  [gs_export]
  base_url = http://yoursite:8080/Plone/portal_setup
  user = youruser
  password = yourpass
  path = /absolute_path_to_dump_diretory_of_git
  mail_server = your.mailserver
  mail_port = 587
  mail_user = your_mail_user
  mail_password= your_mail_pass
  mail_from = your_email_adress
  mail_mode = TLS
  mail_recipient=your_receiving_email_adress
  ignore = structure
      workflow

- base_url must point to portal_setup
- the path must exist
- mail_mode accepts an empty string, TLS and SSL
- This tool only accepts one mail recipient. This could easily by changed though
- ignore accepts multiple parameters. Ignore means, after dumping the
  configuration, the ignore parts are deleted! It is a good idea to ignore
  structure. Multiple values can be added by adding one for each line
  and indenting the elements

GS Export is intended to be run by a cron job. 

Todo
----
- Allow for multiple recipients.

Changes
=======

0.1.2 (2012-12-05)
------------------

- Work around missing subprocess.check_output() in python 2.6
  [pgerken]


0.1.1 (2012-12-03)
------------------

- Make email-message more verbose
  [pbauer]


0.1.0 (2012-09-06)
------------------

- Nothing changed yet.


0.0.5 (2012-09-06)
------------------

- Nothing changed yet.


0.0.4 (2012-09-06)
------------------

- Nothing changed yet.


0.0.3 (2012-09-06)
------------------

- Corrected the classifiers.


0.0.2 (2012-09-06)
------------------

- Adding missing meta information.
- The egg has correct classifiers, but the egg tagged as 0.0.2
  has not!


0.0.1 (2012-09-06)
------------------

- Initial release
sphinxcontrib-programscreenshot 0.0.5
Sphinx extension to include screenshot of programs
License: BSD
Keywords: sphinx screenshot

This Sphinx_ 1.0 extension executes programs during the build step and
includes their screenshot into the documentation.
GUI version of the `sphinxcontrib.programoutput`_ extension.


home: https://github.com/ponty/sphinxcontrib-programscreenshot

documentation: http://ponty.github.com/sphinxcontrib-programscreenshot


Basic usage
============
::

    .. program-screenshot:: xmessage hello
        :prompt:

How it works
========================

#. start Xvfb headless X server using pyvirtualdisplay_
#. redirect program display to Xvfb server by setting $DISPLAY variable.
#. wait some seconds
#. take screenshot by pyscreenshot_ which needs scrot.
#. use ``.. image::`` directive to display image



Installation
============

General
--------

 * install Xvfb_ and Xephyr_
 * install PIL_
 * install scrot
 * install pip_
 * install the program::

    # as root
    pip install sphinxcontrib-programscreenshot

Ubuntu
----------
::

    sudo apt-get install python-pip
    sudo apt-get install scrot
    sudo apt-get install xvfb
    sudo apt-get install xserver-xephyr
    sudo apt-get install python-imaging
    sudo pip install sphinxcontrib-programscreenshot


Uninstall
----------
::

    # as root
    pip uninstall sphinxcontrib-programscreenshot


.. _Sphinx: http://sphinx.pocoo.org/latest
.. _`sphinxcontrib-ansi`: http://packages.python.org/sphinxcontrib-ansi
.. _`sphinx-contrib`: http://bitbucket.org/birkenfeld/sphinx-contrib
.. _setuptools: http://peak.telecommunity.com/DevCenter/EasyInstall
.. _pip: http://pip.openplans.org/
.. _Xvfb: http://en.wikipedia.org/wiki/Xvfb
.. _Xephyr: http://en.wikipedia.org/wiki/Xephyr
.. _PIL: http://www.pythonware.com/library/pil/
.. _pyscreenshot: https://github.com/ponty/pyscreenshot
.. _pyvirtualdisplay: https://github.com/ponty/PyVirtualDisplay
.. _`sphinxcontrib.programoutput`: http://packages.python.org/sphinxcontrib-programoutput/