inspect-dense by AI Models
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 when developing code with AI systems.
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.
1 maintainer
Metadata
1 maintainer
Release files for inspect-dense 0.2.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| inspect_dense-0.2.5.tar.gz | 6.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| inspect_dense-0.2.5-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 13.9 kB
Release files / inspect_dense-0.2.5.tar.gz
| Download URL | inspect_dense-0.2.5.tar.gz |
|---|---|
| Size | 6.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bf7686528fd574227f2690841209bcd6f6e5616ca540317ab251dea15c4f8595
|
|
BLAKE2b-256 checksum How to use checksums |
1eb7e1e20c95da6d7524c80e2b0d09ed7dd10662127b628618570908793b917d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.16
|
Release files / inspect_dense-0.2.5-py3-none-any.whl
| Download URL | inspect_dense-0.2.5-py3-none-any.whl |
|---|---|
| Size | 7.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
58a4f851de2d968d3d1f571c4e08a8f76a579f082adaa538e4cdc947e1dff153
|
|
BLAKE2b-256 checksum How to use checksums |
86338db8f4b7028a3a9ba91210755602ec912044dda39e39b691c8108a856148
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.16
|
