Skip to main content

Directory metadata mapper protocol for documenting directories

Project description

DMMP - Directory Metadata Mapper Protocol

Mapper that generates a group of .md files that represent a specific directory in a file system path, creating linked files that follow the markdown syntax.

Standard metadata format

unique_id
output_folder_path/
output_file_name
output_file_description

Populate a specific directory and its subdirectories in this fashion before building the output (in .dmmp files).

After doing so, run something like the following:

python -m dmmp --dirs-to-map "C:\Path1" 1 --save-path "C:\Path2" --metadata-file-names "name"

C:\Path1 --> path of input.
1 ----------> number of nested folders to check.
C:\Path2 --> path of output.
name -----> name on which the metadata files will be on, without extension.

Now on the output path, you should see a folder that represents the data you provided as input.

Configuration file

After you do those steps, you will see a config.toml in the path you executed the script, to not repeat yourself, you can run the same exact command with this argument:

python -m dmmp --config-file config.toml  

More about the arguments

If you want to make your commands more powerful, run python -m dmmp -h to list all possible arguments and what they do.

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

dmmp-0.2.1.tar.gz (7.6 kB view details)

Uploaded Source

Built Distribution

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

dmmp-0.2.1-py3-none-any.whl (7.3 kB view details)

Uploaded Python 3

File details

Details for the file dmmp-0.2.1.tar.gz.

File metadata

  • Download URL: dmmp-0.2.1.tar.gz
  • Upload date:
  • Size: 7.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for dmmp-0.2.1.tar.gz
Algorithm Hash digest
SHA256 2c228528e232e91f0fd84784fb255827f2ee47fbee273b292bd34f88bd98e0b0
MD5 c0a5214734eb231f14eb59a56e5e5ea2
BLAKE2b-256 f93d8f2e1b5c0b686d6169128f55873a0cf0fa84f6306133c6cb2df7c22ee4d3

See more details on using hashes here.

File details

Details for the file dmmp-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: dmmp-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 7.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for dmmp-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f1ff57caf170560cc98c4e0124c9f9de6f0bf256c6e5c623bef17d49a964d48d
MD5 de655a5052f3cfbfdade1161cde6ddae
BLAKE2b-256 d85f2dcd85e438b090d2957e17ce69ec2e988fd7df430f1046f514dc92b353b1

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