Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/5h1ngy/cli-py-project-pars3r
Minimalist CLI tool for parsing and restoring project structures, tailored for tech enthusiasts and developers.
https://github.com/5h1ngy/cli-py-project-pars3r
automation cli cli-tool developer-tools open-source productivity project-parser prompt-generator python scaffolding
Last synced: 6 days ago
JSON representation
Minimalist CLI tool for parsing and restoring project structures, tailored for tech enthusiasts and developers.
- Host: GitHub
- URL: https://github.com/5h1ngy/cli-py-project-pars3r
- Owner: 5h1ngy
- License: mit
- Created: 2024-12-10T19:18:55.000Z (13 days ago)
- Default Branch: develop
- Last Pushed: 2024-12-10T19:24:52.000Z (13 days ago)
- Last Synced: 2024-12-10T20:28:10.494Z (12 days ago)
- Topics: automation, cli, cli-tool, developer-tools, open-source, productivity, project-parser, prompt-generator, python, scaffolding
- Language: Python
- Homepage:
- Size: 121 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# **CLI-Py-Project-Pars3r**
[](./LICENSE)
[](#)
A Python CLI tool for parsing project structures into prompts and restoring them into a directory scaffolding.
## **Table of Contents**
- [Introduction](#introduction)
- [Features](#features)
- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
- [Project Structure](#project-structure)
- [Testing](#testing)
- [Changelog](#changelog)
- [Contributing](#contributing)
- [License](#license)
## **Introduction**
`CLI-Py-Project-Pars3r` is a Python-based CLI tool designed for:
1. **Packing**: Parsing a project directory into a `.prompt` file that summarizes its contents.
2. **Unpacking**: Restoring the directory scaffolding and files from a `.prompt` file.
This tool is simple to use, globally installable, and ideal for automation.
## **Features**
- ✅ Parse project directories into a summarized `.prompt` file.
- ✅ Restore directories and files from `.prompt` files.
- ✅ Interactive CLI for selecting folders or `.prompt` files.
- ✅ Configurable and extendable.
- ✅ Compatible with Python `>= 3.6`.
## **Requirements**
Ensure the following are installed:
- **Python**: `>= 3.6`
- **pip**: Python package manager
## **Installation**
### Steps:
1. Clone the repository:
```bash
git clone [repository-url]
cd cli-py-project-pars3r
```
2. Install the package:
```bash
pip install .
```
3. Test the command:
```bash
pars3r
```
## **Usage**
Run the main script using:
```bash
pars3r
```
### Core Functionalities:
1. **Packing**:
- Select a folder to analyze.
- Generate a `.prompt` file summarizing its contents.
- The `.prompt` file will include metadata, file paths, and contents.
Example:
```bash
pars3r
```
2. **Unpacking**:
- Select a `.prompt` file from the list.
- Restore the directory scaffolding and files from the `.prompt`.
Example:
```bash
pars3r
```
Follow the interactive prompts to choose the `.prompt` file to unpack.
## **Project Structure**
```plaintext
cli-py-project-pars3r/
├── cli-py-project-pars3r/
│ ├── __init__.py # Package initialization
│ ├── cli.py # Main script
├── setup.py # Configuration for pip
├── README.md # Documentation
├── assets/ # Images and assets for the README
└── tests/ # (Optional) Automated tests
```
## **Testing**
Run automated tests using:
```bash
pytest tests/
```
## **Changelog**
### **v1.1.0**
- Added **interactive file selection** for unpacking `.prompt` files.
- Improved CLI interactivity and error handling.
- Updated README to reflect new features.
### **v1.0.0**
- Initial release:
- Added project parsing and `.prompt` file generation.
- Added directory scaffolding restoration from `.prompt`.
## **License**
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.