diff --git a/README.md b/README.md index 4d4e58f..f063856 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,43 @@ # EZPKL: lovely pickling๐ฅ for context manager hater๐ + [![PyPI version](https://badge.fury.io/py/ezpkl.svg)](https://badge.fury.io/py/ezpkl) [![Python Downloads](https://static.pepy.tech/badge/ezpkl)](https://pepy.tech/project/ezpkl) + +
+ English | + ํ๊ตญ์ด +
+ + ![EZPKL character](https://raw.githubusercontent.com/yesinkim/ezpkl/main/assets/banner.png) -์ปจํ ์คํธ ๋งค๋์ ๋ฅผ ์ด๊ณ ๋ซ๋ ๊ฒ์ด ๊ท์ฐฎ์์ ๋ง๋ค์์ต๋๋ค. +I hate `with open(file_path) as file...` and I don't want to google `how to save pickle in python` anymore. +then, i made it. -## ์ค์น +## Installation -ํจํค์ง ๊ด๋ฆฌ์ [pip](https://pip.pypa.io/en/stable/)๋ฅผ ์ฌ์ฉํ์ฌ ezpkl๋ฅผ ์ค์นํฉ๋๋ค. +Use the package manager [pip](https://pip.pypa.io/en/stable/) to install ezpkl. ```bash pip install ezpkl ``` -## ์ฌ์ฉ๋ฒ +## Usage -### ๊ฐ์ฒด ์ ์ฅํ๊ธฐ +### Save Object to pkl ```python from ezpkl import save_pkl a = [1, 2, 3, 4, 5] -# ํ์ฌ ํด๋์ 'a.pkl'์ด ์ ์ฅ๋ฉ๋๋ค. +# 'a.pkl' will be saved in the current directory. save_pkl(var=a) -# ํ์ฌ ํด๋์ 'a_list_temp.pkl'์ด ์ ์ฅ๋ฉ๋๋ค. +# 'a_list_temp.pkl' will be saved in the current directory. save_pkl(var=a, file_name='a_list_temp') ``` -### ๊ฐ์ฒด ๋ถ๋ฌ์ค๊ธฐ +### Load Object ```python from ezpkl import load_pkl @@ -35,6 +45,6 @@ from ezpkl import load_pkl a = load_pkl('a.pkl') ``` -## ๋ผ์ด์ ์ค +## License [MIT](https://choosealicense.com/licenses/mit/) diff --git a/README_ko.md b/README_ko.md new file mode 100644 index 0000000..b806b56 --- /dev/null +++ b/README_ko.md @@ -0,0 +1,49 @@ +# EZPKL: lovely pickling๐ฅ for context manager hater๐ + + [![PyPI version](https://badge.fury.io/py/ezpkl.svg)](https://badge.fury.io/py/ezpkl) [![Python Downloads](https://static.pepy.tech/badge/ezpkl)](https://pepy.tech/project/ezpkl) + ++ English | + ํ๊ตญ์ด +
+ + +![EZPKL character](https://raw.githubusercontent.com/yesinkim/ezpkl/main/assets/banner.png) +์ปจํ ์คํธ ๋งค๋์ ๋ฅผ ์ด๊ณ ๋ซ๋ ๊ฒ์ด ๊ท์ฐฎ์์ ๋ง๋ค์์ต๋๋ค. + +## ์ค์น + +ํจํค์ง ๊ด๋ฆฌ์ [pip](https://pip.pypa.io/en/stable/)๋ฅผ ์ฌ์ฉํ์ฌ ezpkl๋ฅผ ์ค์นํฉ๋๋ค. + +```bash +pip install ezpkl +``` + +## ์ฌ์ฉ๋ฒ + +### ๊ฐ์ฒด ์ ์ฅํ๊ธฐ + +```python +from ezpkl import save_pkl + +a = [1, 2, 3, 4, 5] + +# ํ์ฌ ํด๋์ 'a.pkl'์ด ์ ์ฅ๋ฉ๋๋ค. +save_pkl(var=a) + +# ํ์ฌ ํด๋์ 'a_list_temp.pkl'์ด ์ ์ฅ๋ฉ๋๋ค. +save_pkl(var=a, file_name='a_list_temp') +``` + +### ๊ฐ์ฒด ๋ถ๋ฌ์ค๊ธฐ + +```python +from ezpkl import load_pkl + +a = load_pkl('a.pkl') +``` + +## ๋ผ์ด์ ์ค + +[MIT](https://choosealicense.com/licenses/mit/)