Metadata-Version: 2.1
Name: argmark
Version: 0.3
Summary: Convert argparse based executable scripts to markdown documents.
Home-page: https://github.com/devanshkv/argmark
Author: Devansh Agarwal
Author-email: devansh.kv@gmail.com
License: UNKNOWN
Description: # argmark
        
        [![GitHub issues](https://img.shields.io/github/issues/devanshkv/argmark?style=flat-square)](https://github.com/devanshkv/argmark/issues)
        [![GitHub forks](https://img.shields.io/github/forks/devanshkv/argmark?style=flat-square)](https://github.com/devanshkv/argmark/forks)
        [![GitHub stars](https://img.shields.io/github/stars/devanshkv/argmark?style=flat-square)](https://github.com/devanshkv/argmark/stars)
        [![GitHub LICENSE](https://img.shields.io/github/license/devanshkv/argmark?style=flat-square)](https://github.com/devanshkv/argmark/LICENSE)
        [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/argmark?style=flat-square)](https://pypi.org/project/argmark)
        [![PyPI](https://img.shields.io/pypi/v/argmark?style=flat-square)](https://pypi.org/project/argmark)
        [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square)](https://github.com/psf/black)
        
        [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fdevanshkv%2Fargmark.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fdevanshkv%2Fargmark?ref=badge_shield)
        
        [![codecov](https://codecov.io/gh/devanshkv/argmark/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/devanshkv/argmark)
          
        
        Convert argparse based executable scripts to markdown documents. It is based on [argdown](https://github.com/9999years/argdown) but has a simpler interface and a cleaner code.
        ### Installation
        ```bash
        pip install argmark
        ```
        
        ### Usage
        Using `argmark` is very simple. For a sample python file [sample_argparse.py](tests/sample_argparse.py):
        
        ```python
        import argparse
        
        parser = argparse.ArgumentParser(
            prog="sample_argparse.py",
            description="Just a test",
            formatter_class=argparse.ArgumentDefaultsHelpFormatter,
        )
        parser.add_argument(
            "-f", "--files", help="Files to read.", required=True, nargs="+",
        )
        values = parser.parse_args()
        ```
        
        Run `argmark -f sample_argparse.py` and it would generate:
        ```markdown
        
            sample_argparse.py
            ==================
            
            # Description
            
            
            Just a test
            # Usage:
            
            
            ```bash
            usage: sample_argparse.py [-h] -f FILES [FILES ...]
            
            ```
                # Arguments
            
            |short|long|default|help|
            | :---: | :---: | :---: | :---: |
            |`-h`|`--help`||show this help message and exit|
            |`-f`|`--files`|`None`|Files to read.|
        
        ```
        
        
        
        ## License
        [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fdevanshkv%2Fargmark.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fdevanshkv%2Fargmark?ref=badge_large)
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Documentation
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Description-Content-Type: text/markdown
