Metadata-Version: 2.1
Name: python-snippet
Version: 0.1.6
Summary: Python and Data Science Snippets on the command line
Home-page: https://github.com/khuyentran1401/python_snippet.git
License: Apache-2.0
Keywords: snippet,cli,command-line
Author: khuyentran1401
Author-email: khuyentran1476@gmail.com
Requires-Python: >=3.6.2,<3.10
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: bs4 (>=0.0.1,<0.0.2)
Requires-Dist: decorator (>=5.0.9,<6.0.0)
Requires-Dist: questionary (>=1.9.0,<2.0.0)
Requires-Dist: requests (>=2.25.1,<3.0.0)
Requires-Dist: rich (>=10.4.0,<11.0.0)
Requires-Dist: textdistance (>=4.2.1,<5.0.0)
Requires-Dist: typer (>=0.3.2,<0.4.0)
Requires-Dist: typer-cli (>=0.0.11,<0.0.12)
Project-URL: Repository, https://github.com/khuyentran1401/python_snippet.git
Description-Content-Type: text/markdown

# Python Snippet Tool

A tool to get Python and data science snippets at [Data Science Simplified](https://mathdatasimplified.com/) on the command line. 

## Installation
```bash
python3 -m pip install --user python-snippet
```
**Note**: _The `--user` is important. It ensures you install it in your directory and not in the global system. `python3 -m` ensures that you install python_snippet using Python 3._

Make sure your Python version is >= 3.6.2.
```bash
python3 --version
```


## Usage
### Search for posts based on category
![gif](https://github.com/khuyentran1401/python_snippet/blob/master/images/search_category2.gif?raw=true)

You can search for posts based on category by typing:
```bash
python-snippet search-category
```
Once you select a post, you will receive an output like below:
![image](https://github.com/khuyentran1401/python_snippet/blob/master/images/search_category2.png?raw=True)
### Search for posts based on a string pattern
![gif](https://github.com/khuyentran1401/python_snippet/blob/master/images/search_posts.gif?raw=true)

You can also search for posts using a string pattern such as `pandas`
```bash
python-snippet search-posts pandas
```
![image](https://github.com/khuyentran1401/python_snippet/blob/master/images/search_posts_pandas.png?raw=true)

To view all commands python-snippet provides, type:
```bash
python-snippet --help
```
![image](https://github.com/khuyentran1401/python_snippet/blob/master/images/help.png?raw=true)

