Divy1211 / py-info-generator

This script reads a python file and generates info about its classes, functions and variables

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Python File Information Generator

This script reads all python files inside a directory (recursively) and generates a JSON data file for each python file. This JSON data file contains detailed information about the different objects declared in the python file like classes, functions, and variables.

Prerequisites

  1. Have Python 3.9 or higher installed. If you do not have python, install it from here.

How to use

  1. Download the script
  2. There are 4 variables IGNORED_DIRS, IGNORED_FILES, BASE_DIR, OUT_DIR in the script which need to be modified as required
  • IGNORED_DIRS: Names of directories to ignore when generating json data files.
  • IGNORED_FILES: Names of files to ignore when generating json data files.
  • BASE_DIR: This is the directory to recursively search and read python files.
  • OUT_DIR: This is the directory to output the json data files to.
  1. Run the script

About

This script reads a python file and generates info about its classes, functions and variables

License:MIT License


Languages

Language:Python 100.0%