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.3.0.tar.gz (3.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: xit2md-0.3.0.tar.gz
  • Upload date:
  • Size: 3.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for xit2md-0.3.0.tar.gz
Algorithm Hash digest
SHA256 962a867007004e117c7383b1e834e747abcd4f5e6c27ff53c1177656deb37395
MD5 f64a635991107b4e4e41fb6e1f4c8a13
BLAKE2b-256 d77acc8a37c4179e517a459738b1692e74a911e06d0157b5327c5c002ce08c30

See more details on using hashes here.

Provenance

The following attestation bundles were made for xit2md-0.3.0.tar.gz:

Publisher: publish.yml on chris48s/xit2md

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

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

File hashes

Hashes for xit2md-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 21115716d636a3ff1f75daa0d7f7362228ba2885569c388b5157a2f376891128
MD5 8a970c0e3072646512213a570b3552d3
BLAKE2b-256 e74dd52b9b63e205b8a27c0cc8a46b03e1b19caa4eb1e91e1ea44cdca606dd29

See more details on using hashes here.

Provenance

The following attestation bundles were made for xit2md-0.3.0-py3-none-any.whl:

Publisher: publish.yml on chris48s/xit2md

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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