Skip to main content

A command line program to generate SCANME.md file content.

Project description

Introduction

To autogenerate SCANME.md, you can globally pip install metadir, and type metadir ..

Usage

Running command metadir . to generate SCANME.md content.

- '*': ''
  README.md: {'*': ''}
  src:
    - '*': ''
      main.py: {'*': ''}
      main.js: {'*': ''}
      core:
        - '*': ''
          app.py: {'*': ''}
  docs:
    - '*': ''
      index.md: {'*': ''}

The values at each level provide ability to specify metaformat for each file and directory in the project by providing URLs to schema specifications.

TODO

  • Implement ignoring of files based on .gitignore, and using regex (look for strings SKIP in the project).

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

metadir-0.0.2.tar.gz (5.0 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page