Metadata-Version: 2.1
Name: DMFO
Version: 0.1.0
Summary: Diff and Merge For Office
Home-page: https://github.com/lcnittl/DMFO
Author: Christian Knittl-Frank
Author-email: lcnittl@gmail.com
License: GPL-3.0
Download-URL: http://pypi.python.org/pypi/DMFO
Project-URL: GitHub: repo, https://github.com/lcnittl/DMFO
Project-URL: GitHub: issues, https://github.com/lcnittl/DMFO/issues
Description: # DMFO -- Diff and Merge For Office
        
        [![badge:pypi-version](https://img.shields.io/pypi/v/DMFO.svg)](https://pypi.org/project/DMFO)
        [![badge:py-versions](https://img.shields.io/pypi/pyversions/DMFO.svg)](https://pypi.org/project/DMFO)
        [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
        [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/lcnittl/DMFO/master.svg)](https://results.pre-commit.ci/latest/github/lcnittl/DMFO/master)
        [![Code style: black](https://img.shields.io/badge/code_style-black-000000)](https://github.com/psf/black)
        [![Code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4)](https://github.com/prettier/prettier)
        
        This is a set of scripts that enable convenient diff and merge of Office-related file
        types (currently Word and PowerPoint (diff only)). The office application will be
        started using COM automation, thus an Office installation is required.
        
        DMFO is LFS compatible.
        
        **Important:** Legacy PowerShell scripts are located in [ps1][ps1] and may still be
        used. However, not all new features will be ported back to the ps1 scripts.
        
        ## Usage
        
        ### Installation
        
        Installable with `pip` or [`pipx`][pipx] (recommended).
        
        ```cmd
        pipx install DMFO
        ```
        
        or
        
        ```cmd
        pipx install git+https://github.com/lcnittl/DMFO.git
        ```
        
        ### Git Integration
        
        These tools are intended to be used with Git, so that `git diff` and `git merge` will
        use Office applications to compare and "merge" files. Simply configure `.gitattributes`
        and `.gitconfig` to support the DMFO diff and merge driver. Enjoy to diff and merge
        Office documents by simply running:
        
        ```cmd
        > git diff
        > git merge
        ```
        
        as usual and with any paramter they accept.
        
        #### `.gitconfig`
        
        Simply register the diff and merge drivers by running `dmfo install` (scope can be given
        by appending `system`, `global`, `local` or `worktree`, default is `global`).
        
        Alternatively, add the entries manually to your git config:
        
        ```ini
        [diff "dmfo"]
        	name = DMFO diff driver
        	command = dmfo diff
        	binary = true
        [merge "dmfo"]
        	name = DMFO merge driver
        	driver = dmfo merge %O %A %B %L %P
        	binary = true
        ```
        
        Make sure that `dmfo`'s path is in your path variable, otherwise prepand `dmfo` with the
        executable's path.
        
        #### `.gitattributes`
        
        Specify the following drivers in your `.gitattributes` file (currently DMFO is only
        supporting Word files):
        
        ```
        *.doc diff=dmfo merge=dmfo
        *.docx diff=dmfo merge=dmfo
        *.ppt diff=dmfo
        *.pptx diff=dmfo
        ```
        
        ### CLI
        
        This option might be added at a later time.
        
        ## Reqirements
        
        - Git (for Windows)
        - Microsoft Office (\[and/or\]: Word, Powerpoint)
        
        ## Platform
        
        In its current implementation, DMFO is suited for Windows 10. Not tested on other
        platforms.
        
        ## License
        
        GNU General Public License v3.0 or later
        
        See [LICENSE][license] for the full text.
        
        [license]: LICENSE
        [extdiff]: https://github.com/ForNeVeR/ExtDiff
        [pipx]: https://pypi.org/project/pipx/
        [ps1]: ps1/
        [pypi]: https://pypi.org/
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Utilities
Requires-Python: >=3.8
Description-Content-Type: text/markdown
