Skip to main content

No project description provided

Project description

dir2md

dir2md is a command line utility for creating a markdown file that includes code blocks for all specified files.

Installation

Install dir2md using pip:

pip install dir2md

Usage

To use dir2md, pass a list of file paths as arguments:

dir2md file1.py file2.py

This will output a markdown file with code blocks for file1.py and file2.py.

Wildcard support

You can use wildcards (*) to pass multiple files at once.

For example, to include all Python files in the current directory:

dir2md *.py

To do so recursively, use **:

dir2md **/*.py

Note that the wildcard statement only works if it is expanded by the shell before the command is run. This means that you must use it in the command line or in a shell script, and it will not work if you pass it as a string to a function that runs the command.

Options

Use the --help flag to view the available options:

dir2md --help

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

dir2md-0.1.0.tar.gz (1.8 kB view details)

Uploaded Source

Built Distribution

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

dir2md-0.1.0-py3-none-any.whl (2.0 kB view details)

Uploaded Python 3

File details

Details for the file dir2md-0.1.0.tar.gz.

File metadata

  • Download URL: dir2md-0.1.0.tar.gz
  • Upload date:
  • Size: 1.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.1 CPython/3.11.1 Darwin/22.1.0

File hashes

Hashes for dir2md-0.1.0.tar.gz
Algorithm Hash digest
SHA256 f600de73674fb59523320c23f88aa919e87d7e265d6d8a615c81aa4e8b609738
MD5 ce3ba4cf44aa3b1fd2f9c59a82839c26
BLAKE2b-256 a3dc6080443d1718c7287c6d2f31cb1a640ad24d2b6f109c12471ddeb7292715

See more details on using hashes here.

File details

Details for the file dir2md-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: dir2md-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 2.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.1 CPython/3.11.1 Darwin/22.1.0

File hashes

Hashes for dir2md-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0544d348008ee5b3682e14f749c2048d9bd1d5e2b83ea796bb433d8f8e64be29
MD5 5cc2b80f9232fca9564c493ac6de1ebe
BLAKE2b-256 2bf0f79473a7d25075b2ee6ba9b8110f8edb9f49ec43e4d5794aab485b609aaa

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