Metadata-Version: 2.1
Name: snap-helpers
Version: 0.1.1
Summary: Helpers for interacting with the Snap system within a Snap
Home-page: https://github.com/albertodonato/snap-helpers
Author: Alberto Donato
Author-email: alberto.donato@gmail.com
Maintainer: Alberto Donato
Maintainer-email: alberto.donato@gmail.com
License: LGPLv3+
Download-URL: https://pypi.org/project/snap-helpers/#files
Description: snap-helpers - Interact with the Snap system within a Snap
        ==========================================================
        
        |Latest Version| |Build Status| |Coverage Status| |Documentation Status|
        
        
        A Python library to interact with snap configuration and properties from inside a snap.
        
        It exposes a top-level ``snaphelpers.Snap`` object which provides access to:
        
        - snap details:
        
          .. code:: python
        
             >>> snap = snaphelpers.Snap()
             >>> snap.name
             'testapp'
             >>> snap.instance_name
             'testapp'
             >>> snap.version
             '0+git.fdf80cd'
             >>> snap.revision
             'x1'
        
        - paths:
        
          .. code:: python
        
             >>> snap.paths.common
             PosixPath('/var/snap/testapp/common')
             >>> snap.paths.data
             PosixPath('/var/snap/testapp/x1')
             >>> snap.paths.snap
             PosixPath('/snap/testapp/x1')
             >>> snap.paths.user_common
             PosixPath('/home/ack/snap/testapp/common')
             >>> snap.paths.user_data
             PosixPath('/home/ack/snap/testapp/x1')
        
        - snap-related environment variables:
        
          .. code:: python
        
             >>> pprint.pprint(dict(snap.environ))
             {'ARCH': 'amd64',
              'COMMON': '/var/snap/testapp/common',
              'CONTEXT': 'ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890',
              'COOKIE': 'ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890',
              'DATA': '/var/snap/testapp/x1',
              'INSTANCE_KEY': '',
              'INSTANCE_NAME': 'testapp',
              'LIBRARY_PATH': '/var/lib/snapd/lib/gl:/var/lib/snapd/lib/gl32:/var/lib/snapd/void',
              'NAME': 'testapp',
              'REEXEC': '',
              'REVISION': 'x1',
              'SNAP': '/snap/testapp/x1',
              'USER_COMMON': '/home/ack/snap/testapp/common',
              'USER_DATA': '/home/ack/snap/testapp/x1',
              'VERSION': '0+git.fdf80cd'}
             >>> snap.environ.ARCH
             'amd64'
        
        - configuration options:
        
          .. code:: python
        
             >>> snap.config.set({'foo.bar': 'baz', 'asdf': 3})  # this needs to be run as root
             >>> options = snap.config.get_options('foo', 'asdf')
             >>> options['foo']
             {'bar': 'baz'}
             >>> options['foo.bar']
             'baz'
             >>> options['asdf']
             3
             >>> options.as_dict()
             {'asdf': 3, 'foo': {'bar': 'baz'}}
        
        
        Hook helpers
        ------------
        
        The library provides helpers to reduce boilerplate when setting up hooks for the snap.
        
        Hooks can be defined by simply registering functions to be called as hooks via
        ``entry_points`` in the application ``setup.py``:
        
        .. code:: python
        
           setup(
               # ...
               entry_points={
                   'snaphelpers.hooks': [
                       'configure = testapp:configure_hook',
                       'install = testapp:install_hook'
                   ]
               }
           )
        
        Hook functions are called with a ``Snap`` object as argument:
        
        .. code:: python
        
           def install_hook(snap: snaphelpers.Snap):
               # ...
        
        
           def configure_hook(snap: snaphelpers.Snap):
               # ...
        
        
        ``snap-helpers`` will take care of the hooks plumbing (i.e. creating hook files
        in ``$SNAP/snap/hooks``).
        
        
        Testing with the snap
        ---------------------
        
        The ``snap-helpers`` snap provides a way to easily test code using the library in
        a real snap environment with strict confinement.
        
        It provides the ``python`` and ``ipython`` commands:
        
        .. code::
        
           $ snap-helpers.python -c 'from pprint import pprint; import snaphelpers; pprint(dict(snaphelpers.SnapEnviron()))'
           {'ARCH': 'amd64',
            'COMMON': '/var/snap/snap-helpers/common',
            'CONTEXT': 'ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890',
            'COOKIE': 'ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890',
            'DATA': '/var/snap/snap-helpers/x1',
            'INSTANCE_KEY': '',
            'INSTANCE_NAME': 'snap-helpers',
            'LIBRARY_PATH': '/var/lib/snapd/lib/gl:/var/lib/snapd/lib/gl32:/var/lib/snapd/void',
            'NAME': 'snap-helpers',
            'REEXEC': '',
            'REVISION': 'x1',
            'SNAP': '/snap/snap-helpers/x1',
            'USER_COMMON': '/home/ack/snap/snap-helpers/common',
            'USER_DATA': '/home/ack/snap/snap-helpers/x1',
            'VERSION': '0+git.26e1e9d'}
        
        The snap can be built and installed as follows:
        
        .. code:: shell
        
           $ snapcraft
           $ sudo snap install --dangerous snap-helpers_*.snap
        
        
        Installation
        ------------
        
        ``snap-helpers`` can be installed from PyPI_.
        
        Run:
        
        .. code:: shell
        
           $ pip install snap-helpers
        
        
        Documentation
        -------------
        
        Full documentation is available on ReadTheDocs_.
        
        
        .. _PyPI: https://pypi.org/
        .. _ReadTheDocs: https://snap-helpers.readthedocs.io/en/latest/
        
        .. |Latest Version| image:: https://img.shields.io/pypi/v/snap-helpers.svg
           :target: https://pypi.python.org/pypi/snap-helpers
        .. |Build Status| image:: https://img.shields.io/travis/albertodonato/snap-helpers.svg
           :target: https://travis-ci.com/albertodonato/snap-helpers
        .. |Coverage Status| image:: https://img.shields.io/codecov/c/github/albertodonato/snap-helpers/master.svg
           :target: https://codecov.io/gh/albertodonato/snap-helpers
        .. |Documentation Status| image:: https://readthedocs.org/projects/snap-helpers/badge/?version=stable
           :target: https://snap-helpers.readthedocs.io/en/stable/?badge=stable
        
Keywords: snap snappy snapcraft
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: System :: Archiving :: Packaging
Provides-Extra: testing
