semvec/pypi-packages huggingface dataset:
code2read 0.2.2.0
Converts your code with comments into a workable README.md: Code more. Write less.
License: MIT

# README
## Contents
1. THE README FOR THIS PROGRAM IS ALSO GENERATED BY THE CODE ITSELF.

2. ADDS ARGUMENTS

3.  FIND THE SIDE COMMENTS AND CREATE CONTENTS LIST

4. FORMAT THE FILE AND SAVE

5.  MAIN FUNCTION

## Docstrings
>This program converts all the comments in your code to a README.md file and saves a lot of your time provided you write comments in your code. It is obvious how easy it is to actually generate the README.md file and save your time.Using the argparse module to get the file path. Note that to run the file
```bash
python -m code2read.code -p <path to file> -o <path to output>
#example
python -m code2read.code -p "setup.py" -o "/Users/lordvile/Downloads/"
```
>
For now this program only supports python.
## Side comments
- Initial file

- Output file

**GENERATED README**
![generatedoutput](output/gen.png)
**INITIAL CODE**
![initialcode](output/code.png)
george-lucas 0.2.1
Plays "A New Hope" on import
License: MIT

Asciitext version of "A New Hope", available from Towel.blinkenlights.nl

Original Work   : Simon Jansen ( http://www.asciimation.co.nz/ )

Telnetification : Sten Spans ( http://blinkenlights.nl/ )

Terminal Tricks : Mike Edwards (pf-asciimation@mirkwood.net)

The hard work was done by Simon and Mike and Sten.
I just made a Python wrapper for the Telnet application.