A tool for recursively describing all files in a directory.
Project description
inspect-dense
inspect-dense is a Python package for recursively describing all python files in a directory. Provides a simple way to get a high-level overview of a project's codebase in a conscise format to minimize tokens used.
Installation
You can install inspect-dense using pip:
Copy code
pip install inspect-dense
Usage
To use inspect-dense, simply import the describe_directory
function from the package and pass it the directory path you want to describe:
python code
from inspect-dense import describe_directory
directory = "/path/to/directory"
output = describe_directory(directory)
The describe_directory
function returns a dictionary with the following structure:
{ "/path/to/file.py": { "functions": { "function_name(args)": "Function docstring" }, "classes": { "Class1": { "methods": { "method1(args)": "Method docstring", "method2(args)": "Method docstring" } }, "Class2": { "methods": { "method3(args)": "Method docstring", "method4(args)": "Method docstring" } } } } }
Command Line Interface
inspect-dense also comes with a command line interface. You can use it to describe a directory and output the results to a file:
inspect-dense <directory> [--no-gitignore]
For example:
inspect-dense /path/to/directory --no-gitignore
This will output the results.
License
This project is licensed under the Apache 2 License - see the LICENSE file for details.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for inspect_dense-0.1.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0d4c9479bb273d21c65f14e3ca228ba8bb3e2085604d574ab9e7331505fb3069 |
|
MD5 | 80917f279e67a00d1a26c850dca66c9b |
|
BLAKE2b-256 | 260212b690ff1cffce601c35361b22e088ba06495a58c6e543a97f555f50b9c7 |