Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gbti-network/py-snapshots-for-ai

This python script creates a machine readable markdown file that describes your application. This can be used to feed updated snapshots of your application to ChatGPT, Grok, Llama, or any other LLM.
https://github.com/gbti-network/py-snapshots-for-ai

chatgpt devops devops-tools grok llama llm py python

Last synced: 4 days ago
JSON representation

This python script creates a machine readable markdown file that describes your application. This can be used to feed updated snapshots of your application to ChatGPT, Grok, Llama, or any other LLM.

Host: GitHub
URL: https://github.com/gbti-network/py-snapshots-for-ai
Owner: gbti-network
Created: 2023-03-05T04:05:48.000Z (almost 2 years ago)
Default Branch: master
Last Pushed: 2024-07-12T01:11:26.000Z (6 months ago)
Last Synced: 2025-01-01T00:07:15.220Z (7 days ago)
Topics: chatgpt, devops, devops-tools, grok, llama, llm, py, python
Language: Python
Homepage: https://gbti.io/ai/how-to-generate-a-markdown-overview-of-your-application-for-chatgpt/
Size: 33.2 KB
Stars: 2
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: readme.md

Awesome Lists containing this project

README

# [Snapshots.py (for AI)](https://gbti.io/assets/snapshots-for-ai/)

Snapshots.py is a tool that allows you to quickly generate machine/AI-readable documentation that shows your project's current folder and file structure, as well as the updated contents of all the files, all inside a markdown file.

![Snapshots Quick Demonstration](https://gbti.io/wp-content/uploads/2023/03/snapshots_for_ai_gif.gif)

## Installation

Integrate `Snapshots.py` into your project by following these steps:

### Step 1: Download the Package from GitHub

1. Visit the GitHub repository at [gbti-labs/py-snapshots-for-ai](https://github.com/gbti-labs/py-snapshots-for-ai/).
2. Click on the green **Code** button, then select **Download ZIP** from the dropdown menu.
3. Save the ZIP file to your desktop or another preferred location and extract its contents.

### Step 2: Copy Required Files to Your Project

From the extracted folder, copy the following files and folders into the base directory of your project application:

- `snapshot.py`: The main script file for generating snapshots.
- `snapshots/`: The directory intended for storing generated snapshot files.

### Step 3: Install Required Dependencies

Open your command line interface (CLI), navigate to your project's base directory, and install the required dependencies using the following commands:

```sh
pip install chardet==5.1.0
pip install gitignore-parser==0.1.3
pip install pyperclip==1.8.2
pip install pytz==2022.7.1
```

This will ensure all necessary libraries are installed for `Snapshots.py` to operate correctly within your project.

### Step 4: Verify Installation

Ensure that `snapshot.py` is located in your project's base directory and that the `snapshots/` folder is present and correctly placed. You're now ready to utilize `Snapshots.py` within your project.

## Usage

Snapshots can be generated by running the `snapshot.py` script, which can be executed in the terminal of your code editor.

`python snapshot.py`

The resulting snapshot markdown files will be present inside the `snapshots/captures` folder.

To preview a snapshot, you can navigate to the `snapshots/captures` folder in the GitHub repo and click on one of the markdown files.

## Features

Snapshots.py includes the following features:

* Auto-detect sensitive keys in JSON files and obfuscate them, so your data is better protected from AI.
* Customizable pattern-based ignore system that helps you prevent including unwanted information in your markdown reports.
* Prependable message to explain to the AI the nature of the markdown document and how to interpret it.

These features can be customized in the `snapshot.py` file.

## Follow GBTI for more

Thanks for reading! If you like our content, please consider following us!