Skip to main content

A package to prepare your software project for continuous infusion into your AI assistant

Project description

Source Infuser

Source Infuser Logo

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 .gitignore in .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:

  1. Go to source-infuser/issues.
  2. If there is no issue similar to the one you encountered, create a new issue.
  3. Describe your case in detail to help us better reproduce and understand the problem.
  4. 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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

source_infuser-0.0.1.tar.gz (4.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

source_infuser-0.0.1-py3-none-any.whl (4.5 kB view details)

Uploaded Python 3

File details

Details for the file source_infuser-0.0.1.tar.gz.

File metadata

  • Download URL: source_infuser-0.0.1.tar.gz
  • Upload date:
  • Size: 4.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.10.14

File hashes

Hashes for source_infuser-0.0.1.tar.gz
Algorithm Hash digest
SHA256 a27dad73800f77524f9b06f9e0acc34480edb211794036f7c90cbc8e80f48655
MD5 5848a248289a9e37a404d14dea81b071
BLAKE2b-256 076446e9f93d1bdb952c42dc2a81869758c07ba32b0a59ed6935d030d8838069

See more details on using hashes here.

File details

Details for the file source_infuser-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: source_infuser-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 4.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.10.14

File hashes

Hashes for source_infuser-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2e7023b1cabfe0c8d026a2807d23051e02d1f25da547ab58c6595534fa84a604
MD5 04b69a5f05a863a1772828251cc2e298
BLAKE2b-256 c58344a5b063d41257de631d5de47f95ff32efa1fbde5d1cb2dff530a8c4fbe6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page