interlocutor: Describing Repositories
interlocutor is a tool for generating descriptions of repositories that are machine-readable. It can output the folder and file structure, process repository contents, and write this information to an output file.
Features
- Generate Directory Structure: Output the folder and file structure of a repository in a clear and organized format that is machine and human-readable.
- Process Repository Files: Extract and save the contents of files in a repository to a structured output file.
- Customizable Output: Specify a preamble, output file, and additional ignore files to customize the output.
- Structure-Only Option: Generate only the directory structure without processing file contents.
Installation
You can install postnormalism using pip:
pip install interlocutor
Usage
Generating Structure Only
To generate only the directory structure of a repository without including file contents:
interlocutor /path/to/git/repository --structure-only -o structure_output.txt
Including a Preamble
You can include a preamble at the beginning of the output file:
interlocutor /path/to/git/repository -p /path/to/preamble.txt -o output.txt
Using Additional Ignore Files
If you want to use additional ignore files along with .gptignore, specify them using the --ignore option:
interlocutor /path/to/git/repository --ignore /path/to/additional_ignore_file.txt -o output.txt
Or Do Your Own Thing
Or just import and use the underlying utility functions.
Contributing
Please submit a start a discussion, create a pull request or create an issue if you have any suggestions or improvements.
Primary Authors
- @jzmiller1 (Zac Miller)
Other Contributors
- N/A
License
interlocutor is released under the MIT License. See the LICENSE file for more information.
Metadata
Release files for interlocutor 0.0.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| interlocutor-0.0.3.tar.gz | 6.3 kB | Without provenance | Details for interlocutor-0.0.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| interlocutor-0.0.3-py3-none-any.whl | Python 3 | none | any | Details for interlocutor-0.0.3-py3-none-any.whl |
Total release size: 12.2 kB
Release files / interlocutor-0.0.3.tar.gz
| Download URL | interlocutor-0.0.3.tar.gz |
|---|---|
| Size | 6.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
03db58950de1e21cfe6fa8958eae19c12b4371990d65330331779c12b9f0d866
|
|
BLAKE2b-256 checksum How to use checksums |
e6f1aaa8bcb242916a0d9491e28ce2d3a878456093c7bda4abbbbfd12da9f4d8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.11.9
|
Release files / interlocutor-0.0.3-py3-none-any.whl
| Download URL | interlocutor-0.0.3-py3-none-any.whl |
|---|---|
| Size | 5.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
781800be7b8efcd06bbf6267564d6cb52417c23aea4e744c8fd401065930465e
|
|
BLAKE2b-256 checksum How to use checksums |
45485f42443dd7ea27327cc03cc02a6e8660a769fc9eefd6f70ac456ab92da32
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.11.9
|
Security for interlocutor 0.0.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.