Skip to main content

Converts your code with comments into a workable README.md: Code more. Write less.

Project description

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

  1. ADDS ARGUMENTS
  2. FIND THE SIDE COMMENTS AND CREATE CONTENTS LIST
  3. FORMAT THE FILE AND SAVE
  4. 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)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for code2read, version 0.2.2.0
Filename, size File type Python version Upload date Hashes
Filename, size code2read-0.2.2.0-py3-none-any.whl (3.5 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size code2read-0.2.2.0.tar.gz (2.6 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page