Metadata-Version: 2.1
Name: SnippyCode
Version: 0.1.8
Summary: A command line extension to add snippets directly in Visual Studio Code.
Home-page: https://github.com/FabioFlorey/SnippyCode
Download-URL: https://pypi.org/project/snippycode/
Author: Fabio Craig Wimmer Florey
Author-email: fabioflorey@icloud.com
Maintainer: 
Maintainer-email: 
License: GPL-v3
Keywords: CLI,Command Line Interface,VSCode,Visual Studio Code,Snippets,Python 3.9,Python 3.10
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Environment :: Win32 (MS Windows)
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development
Classifier: Topic :: Terminals
Classifier: Topic :: Utilities
Requires-Python: >=3.9.0
Description-Content-Type: text/markdown
License-File: LICENSE.md

 <div align="center">
  <img src="https://user-images.githubusercontent.com/93403866/188535751-98022c23-8258-4db0-9816-14df7cd4cf33.png" width="300">
</div>

# SnippyCode
A command line extension to add snippets directly in Visual Studio Code.

![Issues](https://img.shields.io/github/issues/FabioFlorey/SnippyCode)&emsp;
![Pull Requests](https://img.shields.io/github/issues-pr/FabioFlorey/SnippyCode)&emsp;
![License](https://img.shields.io/github/license/FabioFlorey/SnippyCode)

## Project Details
### Prerequisites
This project requires the following prerequisites:

- **OS** : At the moment this module works on <ins>Windows OS</ins>.
- **Language** : <ins>Python >=3.9</ins> must be installed.
- **Tools** : <ins>Visual Studio Code</ins> must be installed.

You can find a list of libraries that were used outside of the Python Standard Library [here](requirements.txt).

### Features
The project has the following features:

- [x] **Add snippet from file** : You can add a snippet from a file with `snip NAME`.
- [x] **Add snippet from clipboard** : You can add a snippet from your clipboard with `snip NAME PATH`.
- [x] **Docstring description** : If you snip a Python Module the description will be its `__doc__`.
- [x] **Update a snippet** :  You can update a snippet with `snip-up NAME`.
- [x] **Remove a snippet** :  You can remove a snippet with `snip-rm NAME`.
- [x] **List all snippets** :  You can list all snippets with `snip-ls`.
- [x] **Terminal agnosticism** :  It works on any terminal and supports relative paths.

## Installation and Usage
### Installation
To install the project, with `pip` by typing `pip install snippycode` in your terminal.

### Usage
TODO


## Licensing and Credits
### Licensing
This project is licensed under the [GNU GPL v3](https://www.gnu.org/licenses/gpl-3.0.html) license. 
The code is open source and available for anyone to use and modify. Please see the [LICENSE](LICENSE.md) file for more information. 

![Downloads](https://img.shields.io/pypi/dm/snippycode)&emsp;
![Followers](https://img.shields.io/github/followers/FabioFlorey?style=social)&emsp;
![Fork](https://img.shields.io/github/forks/FabioFlorey/SnippyCode?style=social)&emsp;
![Stars](https://img.shields.io/github/stars/FabioFlorey/SnippyCode?style=social)&emsp;
![Watchers](https://img.shields.io/github/watchers/FabioFlorey/SnippyCode?style=social)&emsp;

