Opinionated parsing of gemtext.
Project description
trimgmi
Opinionated parsing of gemtext.
Usage
See "convert", "command" and "sample" modules for examples.
FIXME: Document this in more detail.
Description
Gemtext (GMI) is a lightweight, line-oriented markup language designed for the Gemini internet protocol. This module parses gemtext, ignoring extraneous whitespace. Text after closing ``` marks is also ignored.
The resulting objects can be rendered line-by-line without further parsing logic.
Also included are:
- round-trip render back to GMI with minimal whitespace
- simple render to CommonMark
- opinionated render to HTML
- primitive command line tools for the above
Read more about gemtext:
- gemini://gemini.circumlunar.space/docs/gemtext.gmi
- https://gemini.circumlunar.space/docs/gemtext.gmi
Implementation
This module has no external dependencies.
This implementation is deliberately verbose so that a developer can confirm by reading that the parser follows the gemtext specification. Optimising the core module is out-of-scope.
Testing
The following commands should run without changing the target files:
trimgmi test_search
# example.gmi remains tidy
# example.txt remains untidy
# *.license remain unchanged
convertgmi gmi README test_output/README.gmi # identical
convertgmi md README test_output/README.md # readable
convertgmi html README test_output/README.html # readable
FIXME: Implement and document a comprehensive round-trip test harness.
Build
python setup.py sdist bdist_wheel
If everything works as expected you should end up with the files:
dist/trimgmi-<version>-py3-none-any.whl
dist/trimgmi-<version>.tar.gz
You can now optionally upload to PyPI:
twine upload dist/*
Sharing and contributions
trimgmi
https://gitlab.com/lofidevops/trimgmi
Copyright 2022 David Seaward and contributors
SPDX-License-Identifier: GPL-3.0-or-later
Shared under GPL-3.0-or-later. We adhere to the Contributor Covenant 2.0 without modification, and certify origin per DCO 1.1 with a signed-off-by line (git -s). Contributions under the same terms are welcome.
For details see COPYING, CODE_OF_CONDUCT.md (report via private ticket) and CONTRIBUTING.DCO.txt.
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
Built Distribution
File details
Details for the file trimgmi-0.3.0.tar.gz
.
File metadata
- Download URL: trimgmi-0.3.0.tar.gz
- Upload date:
- Size: 6.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.8.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 22f50e5e1691a6d4e13811e5136dc8eb6936da3be15a9a3d415f84c998b65a35 |
|
MD5 | eb8cff0e52e531987d2bb99ebdf25651 |
|
BLAKE2b-256 | f3811c4c1cbf449df2f80374ed725559f55fa2dd70e513633b250404cfbbc0fc |
File details
Details for the file trimgmi-0.3.0-py3-none-any.whl
.
File metadata
- Download URL: trimgmi-0.3.0-py3-none-any.whl
- Upload date:
- Size: 18.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.8.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8fc836ec28c3a4c0e68b94f654f0279ec2185f365555b1974c4e725d0e5208fe |
|
MD5 | e165db258d7fa0fbac8e2c3307e3f692 |
|
BLAKE2b-256 | fd8681cf08a276733221f4bcc5a40b494640f892d99097aecf3e8fcd5935dfbf |