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.
```yaml
- '*': ''
README.md: {'*': ''}
src:
- '*': ''
main.py: {'*': ''}
main.js: {'*': ''}
core:
- '*': ''
app.py: {'*': ''}
docs:
- '*': ''
index.md: {'*': ''}
```
The values at each level provide ability to specify [metaformat](https://book.mindey.com/metaformat/0001-metaform-philosophy/0001-metaform-philosophy.html) 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).
To autogenerate SCANME.md, you can globally `pip install metadir`, and type `metadir .`.
# Usage
Running command `metadir .` to generate `SCANME.md` content.
```yaml
- '*': ''
README.md: {'*': ''}
src:
- '*': ''
main.py: {'*': ''}
main.js: {'*': ''}
core:
- '*': ''
app.py: {'*': ''}
docs:
- '*': ''
index.md: {'*': ''}
```
The values at each level provide ability to specify [metaformat](https://book.mindey.com/metaformat/0001-metaform-philosophy/0001-metaform-philosophy.html) 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
Release history Release notifications | RSS feed
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.1.tar.gz
(4.8 kB
view hashes)