A package to prepare your software project for continuous infusion into your AI assistant
Project description
Source Infuser
Source Infuser helps keep your AI assistant updated with the changes you perform in your software project. It generates detailed reports of your project's structure, which can be continuously infused into your AI assistant.
Features
- Generate markdown reports of your project structure.
- Supports customizable ignore patterns similar to
.gitignorein.psi-ignore. - Easy integration with your existing CI/CD pipelines.
Installation
From Source
You can install the package directly from the GitHub repository:
git clone https://github.com/ivanzhovannik/source-infuser.git
cd source-infuser
pip install .
From PyPi (Feature Under Development)
pip install source_infuser
Usage
To generate a report of the current directory and write it into report.md:
psi -o report.md
or alternatevely
source_infuser -r . -o report.md
Command-line Options:
- -r, --root: Root directory of the project (default: current directory).
- -o, --output: Output markdown file (optional).
Ignore some elements of your project:
In case you want to ignore parts of your root using .gitignore patters, just add .psi-ignore file to your current directory.
Contributions
We welcome contributions! Please follow these steps:
- Go to source-infuser/issues.
- If there is no issue similar to the one you encountered, create a new issue.
- Describe your case in detail to help us better reproduce and understand the problem.
- If you solved the problem yourself, please go ahead and create a pull-request, tag @ivanzhovannik to review.
License
This package is free to use for research or commercial purposes. Any part can be reproduced; just mention the source.
Acknowledgements
Thanks to all users and contributors who made this project better!
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file source_infuser-0.0.3.tar.gz.
File metadata
- Download URL: source_infuser-0.0.3.tar.gz
- Upload date:
- Size: 4.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.9.19
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b6d4d26595741424da8e0cf3b8be90c9233f98720e577bcbe09e67ec81967b4a
|
|
| MD5 |
c66e00f03cce3d9646b9867ac32cfd9f
|
|
| BLAKE2b-256 |
975a45fef653d5ce8b70dc33a9515a7946ad3b38e311f0f2368567d4477c039a
|
File details
Details for the file source_infuser-0.0.3-py3-none-any.whl.
File metadata
- Download URL: source_infuser-0.0.3-py3-none-any.whl
- Upload date:
- Size: 5.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.9.19
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c98744893844bdbef77019d7a72cce14390c4ebaedf36945a7c4c1dabe7e793d
|
|
| MD5 |
1b646a4d75ab8c4deff328d9de452603
|
|
| BLAKE2b-256 |
6c6449ba3c67706ccb471833cdacef7652b287643a6d0f79964c24cd6bc1695c
|