Skip to main content

Convert [x]it! to markdown

Project description

xit2md

Run tests codecov PyPI Version License Python Compatibility Code style: black

[x]it! is a plain-text file format for todos and check lists. xit2md converts a checklist in [x]it! format to markdown task lists. Markdown task lists are available in many markdown dialects including GitHub Flavored Markdown.

Installation

pip install xit2md

Usage

On the Console

# convert [x]it! file to markdown file
$ xit2md in.xit > out.md

# fetch [x]it! file from the web and convert to markdown
$ curl "https://myserver.com/example.xit" | xit2md

As a Library

>>> from xit2md import xit2md_text

>>> xit = """Named Group
... [ ] Open
... [x] Checked
... [@] Ongoing
... [~] Obsolete
... [?] In Question
... """

>>> print(xit2md_text(xit, heading_level=2))
## Named Group
- [ ] Open
- [x] Checked
- [ ] Ongoing
- [x] ~Obsolete~
- [ ] In Question

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

xit2md-0.2.2.tar.gz (3.2 kB view details)

Uploaded Source

Built Distribution

xit2md-0.2.2-py3-none-any.whl (3.9 kB view details)

Uploaded Python 3

File details

Details for the file xit2md-0.2.2.tar.gz.

File metadata

  • Download URL: xit2md-0.2.2.tar.gz
  • Upload date:
  • Size: 3.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for xit2md-0.2.2.tar.gz
Algorithm Hash digest
SHA256 9fdf2b8ecba4b093eceb99b58cde6715f2e7d268cf19f49f262c93c1d31a693d
MD5 cc3c01ad94439477f52b204a0578b8e7
BLAKE2b-256 69316b21c9a97ecadb49aa4d255f2b66d4141abe3b45ed99d0c0fc5aa33bbf4b

See more details on using hashes here.

File details

Details for the file xit2md-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: xit2md-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 3.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for xit2md-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 584f15719b86669e95709a8f974e43cddf2a3f2215e7fd9a639f435ac34c5259
MD5 a873a3c898b5d9aa2ff5ef0d3b2b0acb
BLAKE2b-256 2c4617be91e6ca965689a863559863f0fbe2a8c4e081e39f0d810ad400743d18

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page