Metadata-Version: 2.1
Name: metadir
Version: 0.0.1
Summary: A command line program to generate SCANME.md file content.
Home-page: https://gitlab.com/wefindx/metadir
Author: Mindey
Author-email: mindey@qq.com
License: MIT
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).
        
Keywords: cli
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Topic :: Utilities
Classifier: License :: Public Domain
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Provides-Extra: test
