Metadata-Version: 2.1
Name: sysfstree
Version: 0.1.2
Summary: sysfstree displayes gadget usb information from the ConfigFS and SysFS
Home-page: http://github.com/Belarra/sysfstree
Author: Stuart Lynne
Author-email: stuart.lynne@gmail.com
License: MIT
Download-URL: http://github.com/Belarra/sysfstree.git
Description: # SysFSTree
        
        *sysfstree* implements a generator function that will recursively iterate a file system, typically /sys, retrieving
        the contents of the files, and displaying the path names and data in a fashion similar to the tree(1) command.
        
        A small python module for generating annotated tree(1) style output for /sys items.
        
        This can be used by other modules to generate system specific tools that allow
        for showing system specific information.
        
        Calling sequence:
        
            import sysfstree
        
            sysfs = sysfstree(root, maxlevel, include, exclude):
            for l in sysfs._tree(p, os.listdir(p), "", -1):
                print("%s" % (l))
        
        Where:
        - *root* is the top level path to start at
        - *maxlevel* is the maximum depth to recurse to
        - *include* is a list of requested includes at each recursion level
        - *exclude* is a list of requested excludes at each recursion level
        
        The include and exclude use shell matching (fnmatch).
        
        ## Examples
        
        The sysfstree_raspbian Python package uses this module to display information
        about various various Raspbian specific areas in /sys. For example:
        
            # sysfstree_raspbian --gadget
        
            # sysfstree_raspbian --soc-udc
        
        
        That was generated by:
        
            import sysfstree
                sysfs = sysfstree("/sys/kernel/config/usb_gadget")
                for l in sysfs._tree(p, os.listdir(p), "", -1):
                        print("%s" % (l))
        
            import sysfstree
                sysfs = sysfstree("/sys/kernel/config/usb_gadget")
                for l in sysfs._tree(p, os.listdir(p), "", -1):
                        print("%s" % (l))
        
        
        ## Running Tests
        
        sysfstree currently only has doctests.
        
        Run tests with nose::
        
            nosetests --with-doctest src/sysfstree
        
        Run tests with doctest::
        
            python -m doctest -v src/sysfstree/__init__.py
        
        ## Author
        Stuart.Lynne@belcarra.com
        Copyright (c) 2020 Belcarra Technologies (2005) Corp.
        
        
Keywords: configfs,sysfs,pi,usb,gadget
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Operating System :: POSIX
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Topic :: System :: Logging
Classifier: Topic :: Text Processing
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: System Shells
Classifier: Topic :: System :: Systems Administration
Description-Content-Type: text/markdown
