A tool to convert directory contents to JSON
Project description
DTJ (Directory-to-JSON)
Overview
DTJ (Directory-to-JSON) is a Python command-line tool, particularly useful for quickly generating and sharing representations of directory structures and it's content in a structured and token-efficient manner, making it ideal for interactions with language models like ChatGPT.
Example output
dtj
{
"directory": "my_project",
"contents": [
{
"filename": "main.py",
"content": "# Main application file\nimport app\n\napp.run()"
},
{
"filename": "app.py",
"content": "# App module\n\ndef run():\n print('Running the app')"
},
{
"directory": "utils",
"contents": [
{
"filename": "helper.py",
"content": "# Utility functions\n\ndef helper():\n return 'Helper function'"
}
]
}
]
}
Features
- Convert directory contents to JSON format.
- Include or exclude specific file types.
- Recursive directory parsing.
- Options for output: printing to console, saving to a file, or copying to the clipboard.
Installation
pip install dtj
Usage
Run DTJ from the command line with the following options:
dtj <target-directory> [options]
If no target directory is specified, DTJ will default to the current working directory.
Options:
-i
or--include
: Specify file extensions to include (e.g.,py
,html
).-e
or--exclude
: Specify file extensions to exclude.-o
or--output-file
: Set the output JSON file name.-r
or--recursive
: Enable recursive search in directories.-p
or--print
: Print the output using rich formatting.-c
or--clipboard
: Copy the output to the clipboard.
Example
dtj myfolder -i py html -o output.json -r
This command will parse all .py
and .html
files in myfolder
recursively and save the JSON output to output.json
.
Authors
- Adrian Galilea - Initial work
Acknowledgments
- Hat tip to ChatGPT for assistance with project setup and documentation.
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
dtj-0.1.3.tar.gz
(4.2 kB
view hashes)
Built Distribution
dtj-0.1.3-py3-none-any.whl
(4.6 kB
view hashes)