catpandoc 2021

Cat multiple document files to the terminal

CatPandoc

Cat multiple documents to the terminal. The continuation of CatMD

• Features
  • Document Compatability
  • Terminal 'rendering'
• Roadmap
• Install With PIP
• Use
  • CLI
  • Import
• Language information
  • Built for
• Install Python on Windows
  • Chocolatey
  • Download
• Install Python on Linux
  • Apt
• How to run
  • With VSCode
  • From the Terminal
• How to update, build and publish
• Download
  • Clone
    • Using The Command Line
    • Using GitHub Desktop
  • Download Zip File
• Community Files
  • Licence
  • Changelog
  • Code of Conduct
  • Contributing
  • Security
• Screenshots
  • Desktop
  • Themes

Features

Document Compatability

Lightweight markup formats

• Markdown (including CommonMark and GitHub-flavored Markdown)
• reStructuredText
• Emacs Org-Mode
• Emacs Muse
• Textile
• txt2tags

HTML formats

• (X)HTML 4
• HTML5

Ebooks

• EPUB version 2 or 3
• FictionBook2

Documentation formats

• Haddock markup

Roff formats

• roff man

TeX formats

• LaTeX

XML formats

• DocBook version 4 or 5
• JATS

Outline formats

• OPML

Data formats

• CSV tables

Word processor formats

• Microsoft Word docx
• OpenOffice/LibreOffice ODT

Interactive notebook formats

• Jupyter notebook (ipynb)

Wiki markup formats

• MediaWiki markup
• DokuWiki markup
• TikiWiki markup
• TWiki markup
• Jira wiki markup

Terminal 'rendering'

Highlights the following:

• Headers 1-6
• Unordered and ordered lists
• Block quotes
• Bold, Italic, Strikethrough, inline code
• Line Break (br)

Renders the following

• Tables
• Images (uses catimage for this so they can look a bit blurry...)

Higlights code blocks

• Uses pygments for code syntax highlighting

Roadmap

For completed components, see the changelog (link below)

Feature	Description	Status
pandoc2pysimplegui.py	Generate PySimpleGUI widgets	-

Install With PIP

pip install catpandoc

Head to https://pypi.org/project/catpandoc/ for more info

Use

CLI

usage: application.py [-h] [--width WIDTH] [--theme THEME] file

Import

Take a look at test/catcomplex.py for an example of how to use catpandoc in your own project. Or take a look at the example below

import json
import pypandoc
from catpandoc import pandoc2ansi, processpandoc

output = json.loads(pypandoc.convert_file("cheatsheet.md", 'json'))
for block in output["blocks"]:
	pandoc = pandoc2ansi.Pandoc2Ansi(130, 5, (4, 0, 0))
	processpandoc.processBlock(block, pandoc)
	print(pandoc.genOutput())

Language information

Built for

This program has been written for Python 3 and has been tested with Python version 3.9.0 https://www.python.org/downloads/release/python-380/.

Install Python on Windows

Chocolatey

choco install python

Download

To install Python, go to https://www.python.org/ and download the latest version.

Install Python on Linux

Apt

sudo apt install python3.9

How to run

With VSCode

1. Open the .py file in vscode
2. Ensure a python 3.9 interpreter is selected (Ctrl+Shift+P > Python:Select Interpreter > Python 3.9)
3. Run by pressing Ctrl+F5 (if you are prompted to install any modules, accept)

From the Terminal

./[file].py

How to update, build and publish

1. Ensure you have installed the following dependencies Linux

   wget dephell.org/install | python3.9
   wget https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python3.9
   

   Windows

   (wget dephell.org/install -UseBasicParsing).Content | python
   (wget https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py -UseBasicParsing).Content | python
   

2. Use poetry for the heavy lifting and dephell to generate requirements

   poetry update
   dephell deps convert
   

3. Build/ Publish

   poetry build
   poetry publish
   

   or

   poetry publish --build
   

Download

Clone

Using The Command Line

1. Press the Clone or download button in the top right
2. Copy the URL (link)
3. Open the command line and change directory to where you wish to clone to
4. Type 'git clone' followed by URL in step 2

$ git clone https://github.com/FHPythonUtils/CatPandoc

More information can be found at https://help.github.com/en/articles/cloning-a-repository

Using GitHub Desktop

1. Press the Clone or download button in the top right
2. Click open in desktop
3. Choose the path for where you want and click Clone

More information can be found at https://help.github.com/en/desktop/contributing-to-projects/cloning-a-repository-from-github-to-github-desktop

Download Zip File

1. Download this GitHub repository
2. Extract the zip archive
3. Copy/ move to the desired location

Community Files

Licence

MIT License Copyright (c) FredHappyface (See the LICENSE for more information.)

Changelog

See the Changelog for more information.

Code of Conduct

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone. Please see the Code of Conduct for more information.

Contributing

Contributions are welcome, please see the Contributing Guidelines for more information.

Security

Thank you for improving the security of the project, please see the Security Policy for more information.

Screenshots

Desktop

Themes