Metadata-Version: 2.1
Name: paml2html
Version: 0.1.1
Summary: [P]oker's M[a]de-up [M]arkup [L]anguage to HTML converter
License: MIT
Author: PokerFacowaty
Author-email: pokerfacowaty.bn@gmail.com
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: yattag (>=1.15.1,<2.0.0)
Description-Content-Type: text/markdown

paml2html is a proof-of-concept converter making HTML from [P]oker's M[a]de-up [M]arkup [L]anguage. PaML's docs can be found [here](https://paml.pokerfacowaty.com/). You can also track PaML's & paml2html's development on my [Vikunja list!](https://vikunja.pokerfacowaty.com/share/xSbQeLXtVLmTpqdniQhIjmzLUgdxJwtpUStgIbya/auth)

# Prerequisites
- [Python 3](https://www.python.org/downloads/)
- [yattag](https://www.yattag.org/) (`pip install yattag`)

# Installation
Download the files
- Clone the repo:
```
git clone https://github.com/PokerFacowaty/paml2html
```
- ... or simply download `src/paml2html.py`

# Usage
To use paml2html by itself, simply start it when in the same directory:

```
python paml2html.py
```
(or if you have Python 2 installed)
```
python3 paml2html.py
```

...or you can also import it and use in a different file with `import paml2html` by calling the `paml2html.convert_from_file()` or `paml2html.convert_from_text()` function and providing a filepath or text


## Arguments
`paml2html.py [-h] [--indent INDENT] source_file destination_file`

- `-h, --help` - show help
- `--indent <number>` - the optional amount of spaces used to indent the HTML file, indentation is off by default
- `source_file` - source text file containing PaML content
- `destination_file` - file for the resulting HTML content

