Here’s the **`README.md`** file as a text block for your "Snippy" project:
# 📝 Snippy - A Simple CLI for Managing Code Snippets
Snippy is a lightweight command-line interface (CLI) tool for managing code snippets efficiently. With Snippy, you can create, edit, copy, and delete snippets right from your terminal. It's designed to help developers quickly store and retrieve useful code snippets, all while keeping things simple and straightforward.
## 🚀 Features
- 📂 **Create, list, and manage snippets** easily.
- ✏️ **Open snippets** in your preferred text editor.
- 📋 **Copy snippets** directly to the clipboard.
- 🗑️ **Delete snippets** when they are no longer needed.
## 📦 Installation
To install Snippy, follow these steps:
1. **Clone the repository**:
```bash
git clone https://github.com/TejasBaid/snippy-cli.git
cd snippy-cli
```
2. **Install the package**:
```bash
pip install .
```
> **Note**: Make sure you have Python 3.x and `pip` installed.
## 🛠️ Usage
Once installed, Snippy can be used directly from the terminal using the `snip` command.
### Example Commands:
- **Create a new snippet**:
```bash
snip create my_snippet
```
This command opens your default text editor to create a snippet. The snippet will be saved in the `Snippets/` directory.
- **List all snippets**:
```bash
snip list
```
- **Open a snippet for editing**:
```bash
snip open my_snippet
```
- **Copy a snippet to the clipboard**:
```bash
snip copy my_snippet
```
- **Delete a snippet**:
```bash
snip delete my_snippet
```
- **Display help**:
```bash
snip help
```
## 📖 Available Commands
| Command | Description |
|-------------------------------|-----------------------------------------------------|
| `snip create <snippet_name>` | Create a new snippet |
| `snip list` | List all snippets |
| `snip open <snippet_name>` | Open an existing snippet for editing |
| `snip copy <snippet_name>` | Copy the snippet's content to the clipboard |
| `snip delete <snippet_name>` | Delete a snippet |
| `snip help` | Display this help message |
## 🤝 Contributing
Feel free to submit pull requests, open issues, or suggest new features! Contributions are welcome.
## 📜 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## 🙏 Acknowledgements
- Thanks to the open-source community for the inspiration and support.
```
You can directly copy and paste this into your `README.md` file for your GitHub repository. Let me know if you need any further changes!
Raw data
{
"_id": null,
"home_page": "https://github.com/TejasBaid/snippy-cli",
"name": "snippy-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Tejas Baid",
"author_email": "Tejas Baid <tejasbaid3@gmail.com>",
"download_url": null,
"platform": null,
"description": "Here\u2019s the **`README.md`** file as a text block for your \"Snippy\" project:\n\n\n# \ud83d\udcdd Snippy - A Simple CLI for Managing Code Snippets\n\nSnippy is a lightweight command-line interface (CLI) tool for managing code snippets efficiently. With Snippy, you can create, edit, copy, and delete snippets right from your terminal. It's designed to help developers quickly store and retrieve useful code snippets, all while keeping things simple and straightforward.\n\n## \ud83d\ude80 Features\n- \ud83d\udcc2 **Create, list, and manage snippets** easily.\n- \u270f\ufe0f **Open snippets** in your preferred text editor.\n- \ud83d\udccb **Copy snippets** directly to the clipboard.\n- \ud83d\uddd1\ufe0f **Delete snippets** when they are no longer needed.\n\n## \ud83d\udce6 Installation\n\nTo install Snippy, follow these steps:\n\n1. **Clone the repository**:\n ```bash\n git clone https://github.com/TejasBaid/snippy-cli.git\n cd snippy-cli\n ```\n\n2. **Install the package**:\n ```bash\n pip install .\n ```\n\n> **Note**: Make sure you have Python 3.x and `pip` installed.\n\n## \ud83d\udee0\ufe0f Usage\n\nOnce installed, Snippy can be used directly from the terminal using the `snip` command.\n\n### Example Commands:\n\n- **Create a new snippet**:\n ```bash\n snip create my_snippet\n ```\n This command opens your default text editor to create a snippet. The snippet will be saved in the `Snippets/` directory.\n\n- **List all snippets**:\n ```bash\n snip list\n ```\n\n- **Open a snippet for editing**:\n ```bash\n snip open my_snippet\n ```\n\n- **Copy a snippet to the clipboard**:\n ```bash\n snip copy my_snippet\n ```\n\n- **Delete a snippet**:\n ```bash\n snip delete my_snippet\n ```\n\n- **Display help**:\n ```bash\n snip help\n ```\n\n## \ud83d\udcd6 Available Commands\n\n| Command | Description |\n|-------------------------------|-----------------------------------------------------|\n| `snip create <snippet_name>` | Create a new snippet |\n| `snip list` | List all snippets |\n| `snip open <snippet_name>` | Open an existing snippet for editing |\n| `snip copy <snippet_name>` | Copy the snippet's content to the clipboard |\n| `snip delete <snippet_name>` | Delete a snippet |\n| `snip help` | Display this help message |\n\n## \ud83e\udd1d Contributing\n\nFeel free to submit pull requests, open issues, or suggest new features! Contributions are welcome.\n\n## \ud83d\udcdc License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## \ud83d\ude4f Acknowledgements\n\n- Thanks to the open-source community for the inspiration and support.\n```\n\nYou can directly copy and paste this into your `README.md` file for your GitHub repository. Let me know if you need any further changes!\n",
"bugtrack_url": null,
"license": null,
"summary": "A CLI tool for managing code snippets",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/TejasBaid/snippy-cli"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1f7f0d00659a1523854156a33d5a947ad99a7f88d18c9fa3b22f646fb79f1d3a",
"md5": "03eb4a7400ab479df45eaef8963a302d",
"sha256": "10e5fbf7265edafee1ea7d7347a0f1f86f8d7e6f0778059348cc06e8a3db4119"
},
"downloads": -1,
"filename": "snippy_cli-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "03eb4a7400ab479df45eaef8963a302d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 5893,
"upload_time": "2024-10-20T14:07:14",
"upload_time_iso_8601": "2024-10-20T14:07:14.919548Z",
"url": "https://files.pythonhosted.org/packages/1f/7f/0d00659a1523854156a33d5a947ad99a7f88d18c9fa3b22f646fb79f1d3a/snippy_cli-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-20 14:07:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "TejasBaid",
"github_project": "snippy-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "snippy-cli"
}
JSON
