commit 1daa13e736a049dbb1ea4513a07d72edfe5e8218
parent 96006ff4fd5b8aaba75a60469e652c83aeaf1a1e
Author: Amit Dutta <amitdutta4255@gmail.com>
Date: Thu, 5 Feb 2026 13:46:16 +0530
imp files uploaded
Diffstat:
4 files changed, 178 insertions(+), 0 deletions(-)
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,27 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at **mail@amit.is-a.dev**. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident.+
\ No newline at end of file
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,50 @@
+# Contributing to Pyrgo
+
+First off, thanks for taking the time to contribute!
+
+The following is a set of guidelines for contributing to Pyrgo. These are just guidelines, not rules. Use your best judgment and feel free to propose changes to this document in a pull request.
+
+## How Can I Contribute?
+
+### Reporting Bugs
+This section guides you through submitting a bug report for Pyrgo. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.
+
+- **Use a clear and descriptive title** for the issue to identify the problem.
+- **Describe the exact steps which reproduce the problem** in as many details as possible.
+- **Provide specific examples** to demonstrate the steps.
+
+### Pull Requests
+
+1. **Fork the repository** on GitHub.
+2. **Clone your fork** locally:
+ ```bash
+ git clone [https://github.com/your-username/pyrgo.git](https://github.com/your-username/pyrgo.git)
+ cd pyrgo
+ ```
+3. **Create a virtual environment** to keep dependencies isolated:
+ ```bash
+ python -m venv venv
+ source venv/bin/activate # On Windows use `venv\Scriptsctivate`
+ ```
+4. **Install dependencies** (we use Poetry/pip):
+ ```bash
+ pip install -r requirements.txt
+ ```
+5. **Create a new branch** for your feature or fix:
+ ```bash
+ git checkout -b feature/amazing-feature
+ ```
+6. **Commit your changes** with clear messages:
+ ```bash
+ git commit -m "Add some amazing feature"
+ ```
+7. **Push to the branch**:
+ ```bash
+ git push origin feature/amazing-feature
+ ```
+8. **Open a Pull Request** on the main Pyrgo repository.
+
+## Style Guide
+- We follow **PEP 8** standards.
+- Please write clear comments for complex logic.
+- If you add a new feature, please add a corresponding test case (if applicable).+
\ No newline at end of file
diff --git a/README.md b/README.md
@@ -0,0 +1,68 @@
+# Pyrgo
+
+> **Execute Python code directly from GitHub, explore remote repositories, and find files instantly.**
+
+Pyrgo is a lightweight CLI tool that turns GitHub into your remote Python interpreter. Whether you want to quickly test a script without cloning a massive repo, inspect a file's content, or map out a project structure, Pyrgo handles it in seconds.
+
+## Features
+
+* **Remote Execution**: Run Python scripts directly from raw GitHub URLs.
+* **Safety First**: Inspect code before execution to ensure no malicious activity.
+* **Repo Exploration**: View the contents of remote folders without leaving your terminal.
+* **Deep Search**: Find specific files inside complex repositories instantly.
+* **Smart Caching**: (Coming Soon) Caches files locally to save bandwidth.
+
+## Installation
+
+```bash
+pip install pyrgo
+```
+
+## Usage
+
+### 1. Run a Script
+Don't clone the whole repo just to run one file.
+
+```bash
+# Basic run
+pyrgo run [https://github.com/notamitgamer/adpkg/blob/main/test1.py](https://github.com/notamitgamer/adpkg/blob/main/test1.py)
+
+# Inspect source code before running (Recommended)
+pyrgo run [https://github.com/notamitgamer/adpkg/blob/main/test1.py](https://github.com/notamitgamer/adpkg/blob/main/test1.py) --inspect
+```
+
+### 2. Show Folder Structure
+Visualize what's inside a remote directory.
+
+```bash
+pyrgo show [https://github.com/notamitgamer/adpkg/tree/main/subfolder](https://github.com/notamitgamer/adpkg/tree/main/subfolder)
+```
+
+### 3. Find a File
+Searching for a config file or specific logic?
+
+```bash
+# Syntax: pyrgo find <repo-url> <filename-or-extension>
+pyrgo find [https://github.com/notamitgamer/adpkg](https://github.com/notamitgamer/adpkg) "config.py"
+pyrgo find [https://github.com/notamitgamer/adpkg](https://github.com/notamitgamer/adpkg) ".json"
+```
+
+## Development
+
+We use `poetry` for dependency management.
+
+1. Clone the repo.
+2. Install dependencies: `poetry install`
+3. Run the CLI locally: `poetry run pyrgo --help`
+
+## Contributing
+
+Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md) to get started.
+
+## Security
+
+Found a bug? Please check our [Security Policy](SECURITY.md).
+
+## License
+
+This project is licensed under the MIT License.+
\ No newline at end of file
diff --git a/SECURITY.md b/SECURITY.md
@@ -0,0 +1,29 @@
+# Security Policy
+
+## Supported Versions
+
+Use this section to tell people about which versions of your project are currently being supported with security updates.
+
+| Version | Supported |
+| ------- | ------------------ |
+| 1.0.x | :white_check_mark: |
+| < 1.0 | :x: |
+
+## Reporting a Vulnerability
+
+We take security seriously. If you discover a vulnerability, please do not report it via GitHub Issues. Instead, follow the instructions below:
+
+### 1. General Security Inquiries
+For general security concerns or non-critical issues, please email us at:
+ **mail@amit.is-a.dev**
+
+### 2. Critical/Instant Reporting
+For critical vulnerabilities that require immediate attention (e.g., remote code execution exploits, leaked credentials), please contact the maintainer directly:
+ **amitdutta4255@gmail.com**
+
+### 3. Response Timeline
+* You will receive an acknowledgment within 24 hours.
+* We aim to send a fix or a detailed plan within 72 hours.
+* Please allow us time to patch the issue before disclosing it publicly.
+
+Thank you for helping keep Pyrgo safe!+
\ No newline at end of file