Skip to main content

Diff tools

Project description

Info:

See <https://github.com/jmfranck/pyDiffTools>

Author:

J. M. Franck <https://github.com/jmfranck>

this is a set of tools to help with merging, mostly for use with vim.

The scripts are accessed with the command pydifft

included are (listed in order of fun/utility):

  • pydifft cpb <filename.md> (“continuous pandoc build”) This continuously monitors filename.md, build the result, and displays it in your browser.

    Continuous pandoc build. This works very well together with the g/ vim command (supplied by our standard vimrc gist) to search for phrases (for example g/ n sp me to find “new spectroscopic methodology” – this works much better than you would expect)

    For this to work, you need to install selenium with pip install selenium not conda. Then go to the selenium page and download the chrome driver. Note that from there, it can be hard to find the chrome driver – as of this update, the drivers are here, but it seems like google is moving them around. You also need to install pandoc as well as pandoc-crossref (currently tested on windows with version 3.5 of the former, not the latest installer, since crossref isn’t built with the most recent version).

  • pydifft wgrph <graph.yaml> watches a YAML flowchart description, rebuilds the DOT/SVG output using GraphViz, and keeps a browser window refreshed as you edit the file. This wraps the former flowchart/watch_graph.py script so all of its functionality is now available through the main pydifft entry point.

  • pydifft tex2qmd file.tex converts LaTeX sources to Quarto markdown. The converter preserves custom observation blocks and errata tags while translating verbatim/python environments into fenced code blocks so the result is ready for the Pandoc-based builder.

  • pydifft qmdb [–watch] [–no-browser] [–webtex] runs the relocated fast_build.py logic from inside the package. Without --watch it performs a single build of the configured _quarto.yml targets into the _build/_display directories; with --watch it starts the HTTP server and automatically rebuilds the staged fragments whenever you edit a .qmd file.

  • pydifft qmdinit [directory] scaffolds a new Quarto-style project using the bundled templates and example project1 hierarchy, then downloads MathJax into _template/mathjax so the builder can run immediately. This is analogous to git init for markdown notebooks.

  • pydifft wr <filename.tex|md> (wrap) This provides a standardized (and short) line wrapping, ideal for when you are working on manuscripts that you are version tracking with git.

  • pydifft wmatch (“whitespace match”): a script that matches whitespace between two text files.

    • pandoc can convert between markdown/latex/word, but doing this messes with your whitespace and gvimdiff comparisons.

    • this allows you to use an original file with good whitespace formatting as a “template” that you can match other (e.g. pandoc converted file) onto another

  • pydifft wd (“word diff”): generate “track changes” word files starting from pandoc markdown in a git history. Assuming that you have copied diff-doc.js (copied + licensed from elsewhere) into your home directory, this will use pandoc to convert the markdown files to MS Word, then use the MS Word comparison tool to generate a document where all relevant changes are shown with “track changes.”

    • by default, this uses the file template.docx in the current directory as a pandoc word template

  • pydifft sc (“split conflicts”): a very basic merge tool that takes a conflicted file and generates a .merge_head and .merge_new file, where basic

    • you can use this directly with gvimdiff, you can use the files in a standard gvimdiff merge

      • unlike the standard merge tool, it will

    • less complex than the gvimdiff merge tool used with git.

    • works with “onewordify,” below

  • a script that searches a notebook for numbered tasks, and sees whether or not they match (this is for organizing a lab notebook, to be described)

Future versions will include:

  • Scripts for converting word html comments to latex commands.

  • converting to/form one word per line files (for doing things like wdiff, but with more control)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pydifftools-0.1.14.tar.gz (1.5 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pydifftools-0.1.14-py3-none-any.whl (83.1 kB view details)

Uploaded Python 3

File details

Details for the file pydifftools-0.1.14.tar.gz.

File metadata

  • Download URL: pydifftools-0.1.14.tar.gz
  • Upload date:
  • Size: 1.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pydifftools-0.1.14.tar.gz
Algorithm Hash digest
SHA256 959bef05eabc0f3d4302ddc8503903551303c2501b23bc904a2a5cd4c98e9bd1
MD5 618c247afe5c088491e139c8358487d5
BLAKE2b-256 cf1b7a217a560273cce1140ce788d2ecdec8de87161bc9ecfb9eb11b3997d211

See more details on using hashes here.

File details

Details for the file pydifftools-0.1.14-py3-none-any.whl.

File metadata

  • Download URL: pydifftools-0.1.14-py3-none-any.whl
  • Upload date:
  • Size: 83.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pydifftools-0.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 bae3ba352572b32813531390c14656e8d2c9f093fd2588da6a6203d308bb422c
MD5 29caa4c424471413df469905d030bf7a
BLAKE2b-256 0eca7b8cf514bb765fca6b64e8087819d224d1550cf8da3ec769ec46c21ed4a2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page