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.

Source Distribution

code2read-0.2.2.0.tar.gz (2.6 kB view details)

Uploaded Source

Built Distribution

code2read-0.2.2.0-py3-none-any.whl (3.5 kB view details)

Uploaded Python 3

File details

Details for the file code2read-0.2.2.0.tar.gz.

File metadata

  • Download URL: code2read-0.2.2.0.tar.gz
  • Upload date:
  • Size: 2.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.5

File hashes

Hashes for code2read-0.2.2.0.tar.gz
Algorithm Hash digest
SHA256 b89c326c7143fc07ba736359d8143b412f1bb1051d0202ef8d6df25652073ab4
MD5 c23972da3544e33a2681870ac755d91f
BLAKE2b-256 f3eb706f1bf1e3551fc5d904a72ee3e5b93a4f7692025c7e0618c26a6166606b

See more details on using hashes here.

Provenance

File details

Details for the file code2read-0.2.2.0-py3-none-any.whl.

File metadata

  • Download URL: code2read-0.2.2.0-py3-none-any.whl
  • Upload date:
  • Size: 3.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.5

File hashes

Hashes for code2read-0.2.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2b94d0b846345a9dab5c6a4c3eaf2d12addae4ba5456bdd00c3fa087eef7584e
MD5 4d098d746f1fee30880b1bb86bfdfc29
BLAKE2b-256 8799936fb36996c3bfb9a4c4ae90f75220b3c2e2fa3b2cd20a01e5d752206c4b

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page