https://github.com/jpmvferreira/markpanso

A Python script to turn a Espanso package written in the YAML format into a Markdown styled table.
https://github.com/jpmvferreira/markpanso

cli espanso

Last synced: 9 days ago
JSON representation

A Python script to turn a Espanso package written in the YAML format into a Markdown styled table.

• Host: GitHub
• URL: https://github.com/jpmvferreira/markpanso
• Owner: jpmvferreira
• License: mit
• Created: 2021-04-09T14:02:34.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-04-09T18:38:10.000Z (over 3 years ago)
• Last Synced: 2024-08-14T07:09:19.199Z (4 months ago)
• Topics: cli, espanso
• Language: Python
• Homepage:
• Size: 1.95 KB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - jpmvferreira/markpanso - A Python script to turn a Espanso package written in the YAML format into a Markdown styled table. (Python)

README

        
# Markpanso

A Python script to turn a Espanso package written in the YAML format into a Markdown styled table

## Installation

Simply cloning or downloading this repository to get the `markpanso.py` Python script will do.

For convenience rename this file to `markpanso` and place it in your `$PATH`, which for a standard UNIX system should be at `~/.local/bin`. Then, from a terminal, type `markpanso` to use this script.

## Usage

Tell `markpanso` where your Espanso package is at:

```

markpanso /path/to/package/package.yml

```

And the Markdown styled table will be printed to your terminal.

If you want to store that table in a file, then use the `-o` or `--output` flag to point it to an arbitrary placed file (supports relative paths):

```

markpanso /path/to/package/package.yml -o /path/to/store/table.txt

```

And the contents that would be printed to stdout will be placed in `/path/to/store/table.txt`

## References

- [Compart/Unicode](https://www.compart.com/en/unicode/): Massive agregator for all Unicode symbols organized into categories that also allows you to search a symbol knowing it's name and vice-versa. This is the best place to look for specific symbols by name or by category giving you a full organized overview of the Unicode standard.

- [unicodedata documentation](https://docs.python.org/3/library/unicodedata.html): Docs for the Python package `unicodedata`.

- [PyYAML documentation](https://pyyaml.org/wiki/PyYAMLDocumentation): Documentation for the Python package `yaml`.

- [python-tabulate](https://github.com/astanin/python-tabulate): Repository for the Python package`python-tabulate`, includes documentation.

## License

This package is licensed under the MIT license.

For further information refer to the file `LICENSE` available on this repository.