Simple library to generate pdf books from markdown files
Project description
# Nicebook
This is a tool to convert markdown files into well formatted pdfs with a lot of customizations through a simple yet powerful config file. No need to work with latex templates or Lua scripts.
## Usage
`bash nicebook -i file1.md file2.md folder_with_md -o output.pdf -c nicebook.yml `
If you want to generate a default config so that you can customize it, you can use the following command
`bash nicebook -g `
This will generate a file nicebook.yml that you can then tweak for your needs
## Security implications
Text input is not sanitized before writing to pdf which means that you need to do this on your side in case the text comes from an unstrusted source or HTML will potentially be injected and rendered into the PDF
Also, the configurations are assumed as safe so they are not escaped either.
## Contributing
### Running Tests
`bash python -m unittest python -m nicebook.cli -i tests/test_files/complex.md -o tmp/output.pdf `
### Build
`bash python setup.py sdist bdist_wheel pip install -e . # Make sure it works ... python -m build twine upload dist/* `
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file nicebook-0.1.3.tar.gz.
File metadata
- Download URL: nicebook-0.1.3.tar.gz
- Upload date:
- Size: 22.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
16d628f01b00a81f67c821f4d97a15f147be2c30cd8a6c7c340f6cbbd75963d0
|
|
| MD5 |
6afce39640de2aa252fbd23cb18675a7
|
|
| BLAKE2b-256 |
39f71334f3ae1b0141d03f5fee077e9692d2a62e153d418ee263795a42ae0994
|
Provenance
The following attestation bundles were made for nicebook-0.1.3.tar.gz:
Publisher:
release.yml on luisfontes19/nicebook
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
nicebook-0.1.3.tar.gz -
Subject digest:
16d628f01b00a81f67c821f4d97a15f147be2c30cd8a6c7c340f6cbbd75963d0 - Sigstore transparency entry: 173612601
- Sigstore integration time:
-
Permalink:
luisfontes19/nicebook@faeee032074c197a2cb564e782fa6f78a4e273d1 -
Branch / Tag:
refs/heads/master - Owner: https://github.com/luisfontes19
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@faeee032074c197a2cb564e782fa6f78a4e273d1 -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file nicebook-0.1.3-py3-none-any.whl.
File metadata
- Download URL: nicebook-0.1.3-py3-none-any.whl
- Upload date:
- Size: 25.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
87396023a290a6176159e3a44c99de628c9d7d4d0e9533a67a12f16488f149df
|
|
| MD5 |
9838e5c4ab8a75de84fa415300f5cc04
|
|
| BLAKE2b-256 |
98f1e05593664efb9fa06fb53389bf65507810c720cef6cb9a72b7e44cc6d672
|
Provenance
The following attestation bundles were made for nicebook-0.1.3-py3-none-any.whl:
Publisher:
release.yml on luisfontes19/nicebook
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
nicebook-0.1.3-py3-none-any.whl -
Subject digest:
87396023a290a6176159e3a44c99de628c9d7d4d0e9533a67a12f16488f149df - Sigstore transparency entry: 173612603
- Sigstore integration time:
-
Permalink:
luisfontes19/nicebook@faeee032074c197a2cb564e782fa6f78a4e273d1 -
Branch / Tag:
refs/heads/master - Owner: https://github.com/luisfontes19
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@faeee032074c197a2cb564e782fa6f78a4e273d1 -
Trigger Event:
workflow_dispatch
-
Statement type: