Skip to main content

Convert code files to Markdown (CLI and library)

Project description

c2m-by-nery

Convert code files to Markdown. Use it as a CLI or as a Python library.

Requirements

  • Python 3.10+

Install

pip install c2m-by-nery

Or for a global CLI (available system-wide):

cd /path/to/c2m-by-nery
pipx install .

Editable install for local development:

pip install -e .

Release

3. Build the package (local)

From the project directory:

python -m pip install --upgrade build
python -m build

This creates distribution files in dist/ (a .tar.gz and a .whl).

4. Upload to PyPI with Twine

Install Twine:

python -m pip install --upgrade twine

Upload:

python -m twine upload dist/*

Usage

c2m [PATH] [OPTIONS]

Examples:

c2m .
c2m src --frontmatter

Library

from c2m_by_nery.core import convert_to_markdown

result = convert_to_markdown(root=".", frontmatter=True)

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

c2m_by_nery-0.2.0.tar.gz (17.4 kB view details)

Uploaded Source

Built Distribution

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

c2m_by_nery-0.2.0-py3-none-any.whl (17.5 kB view details)

Uploaded Python 3

File details

Details for the file c2m_by_nery-0.2.0.tar.gz.

File metadata

  • Download URL: c2m_by_nery-0.2.0.tar.gz
  • Upload date:
  • Size: 17.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for c2m_by_nery-0.2.0.tar.gz
Algorithm Hash digest
SHA256 a35e5bf6cc02aa5e7d8e99f6578b9b756e60b081bd2f4dcc0e004736ef3c237e
MD5 db9ff0d33e4e23d434701642d340e346
BLAKE2b-256 ed50d25b9f76df5926252693dbe7eed7494bf8ba36c6f6d7803b4cac36efb258

See more details on using hashes here.

File details

Details for the file c2m_by_nery-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: c2m_by_nery-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 17.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for c2m_by_nery-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1ad156c240af6b8075499f610cd6b5f5e9a25bd512e02dafa40ac6f94e1f86a4
MD5 45048734d4df5f2f20b60d527fde15e1
BLAKE2b-256 35bdc8807365cfddfbfc7d15f65b2da2d06e3097c7479cfec3884aabb42f5674

See more details on using hashes here.

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