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.2.tar.gz (4.6 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.2-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: source_infuser-0.0.2.tar.gz
  • Upload date:
  • Size: 4.6 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.2.tar.gz
Algorithm Hash digest
SHA256 c45100cb4d24d817070d8857a8016f1ee949f1ba4eadab479b5071c731bd35d8
MD5 0eb62a6a6a5fe366a922b67d5913c13d
BLAKE2b-256 89a942eff3a13e39741234518d8d010fb217d840c683fccfbe6b8056f509a0fa

See more details on using hashes here.

File details

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

File metadata

  • Download URL: source_infuser-0.0.2-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.10.14

File hashes

Hashes for source_infuser-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 dca08fffd1df8e3e839c8ae58707c965cf8e584c8eba836789bdc51f0660dd38
MD5 bcad616b41fb15c84ad30c2dc99b313f
BLAKE2b-256 5e5353e449f11978350f2fa870f83cf0fab1f8ba5aad6dfbba51b09637ee4d2c

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