Metadata-Version: 2.1
Name: openpack
Version: 2.2.0
Summary: openpack
Home-page: https://github.com/yougov/openpack
Author: Jason R. Coombs
Author-email: jaraco@jaraco.com
License: UNKNOWN
Description: .. image:: https://img.shields.io/pypi/v/openpack.svg
           :target: `PyPI link`_
        
        .. image:: https://img.shields.io/pypi/pyversions/openpack.svg
           :target: `PyPI link`_
        
        .. _PyPI link: https://pypi.org/project/openpack
        
        .. image:: https://github.com/yougov/openpack/workflows/Automated%20Tests/badge.svg
           :target: https://github.com/yougov/openpack/actions?query=workflow%3A%22Automated+Tests%22
           :alt: Automated Tests
        
        .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
           :target: https://github.com/psf/black
           :alt: Code style: Black
        
        .. image:: https://readthedocs.org/projects/openpack/badge/?version=latest
           :target: http://openpack.readthedocs.io/en/latest/?badge=latest
        
        Status
        ======
        
        ``openpack`` provides base functionality for working with the `Open
        Office XML (OOXML) <http://en.wikipedia.org/wiki/Office_Open_XML>`_
        format in Python.
        
        Introduction
        ============
        
        Openpack is a base library for OpenXML documents. It's used by the `paradocx
        <http://bitbucket.org/yougov/paradocx>`_ and `Xlsxcessive
        <https://bitbucket.org/dowski/xlsxcessive>`_.
        
        Utilities
        =========
        
        Openpack includes two utilities for working with OpenXML documents from the
        command-line, `part-edit` and `zip-listdir`.
        
        These commands are additionally exposed as modules and may be invoked
        using ``python -m``, e.g. ``python -m openpack.part-edit``.
        
        zip-listdir
        -----------
        
        `zip-listdir` isn't specific to OpenXML, and will work on any zip file.
        However, since OpenXML documents are themselves zip files, it's useful to have
        when working with OpenXML::
        
            > zip-listdir ..\paradocx\data.docx
              [Content_Types].xml
            d _rels
            d word
        
        `zip-listdir` lists the files and directories and can be used to list
        sub-directories as well::
        
            > zip-listdir ..\paradocx\data.docx/word
            d _rels
              document.xml
        
        part-edit
        ---------
        
        While `zip-listdir` enables inspecting the structure of the zip content of
        an OpenXML document, `part-edit` facilitates editing the various parts of
        those documents using the client's text editor. For example, to edit the
        `word/document.xml` as found in data.docx from the previous example, simply
        invoke part-edit::
        
            > part-edit ..\paradocx\data.docx/word/document.xml
        
        The program will attempt to use the default text editor to edit the file. If
        the default editor is not sufficient, the user may specify an editor by
        setting either XML_EDITOR or EDITOR environment variables.
        
        `part-edit` will parse the zip file, locate the content within the zip file,
        extract that content to a temporary file, and then open that content in an
        editor. After the editor is closed, if the file was changed, the zip file
        will be updated with the new content.
        
        The user may pass the optional `--reformat-xml`, in which case the XML will
        be pretty-formatted for easier human readability.
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.6
Provides-Extra: testing
Provides-Extra: docs
