Skip to content

Commit

Permalink
📝 Update: add README_ko, badges.
Browse files Browse the repository at this point in the history
  • Loading branch information
yesinkim committed Mar 31, 2024
1 parent 1597d8f commit 03e0cdd
Show file tree
Hide file tree
Showing 2 changed files with 68 additions and 9 deletions.
28 changes: 19 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,50 @@
# 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)

<h4 align="center">
<p>
English |
<a href="https://github.com/yesinkim/ezpkl/blob/main/README_ko.md">한국어</a>
</p>
</h4>

![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

a = load_pkl('a.pkl')
```

## 라이선스
## License

[MIT](https://choosealicense.com/licenses/mit/)
49 changes: 49 additions & 0 deletions README_ko.md
Original file line number Diff line number Diff line change
@@ -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)

<h4 align="center">
<p>
<a href="https://github.com/yesinkim/ezpkl/">English</a> |
한국어
</p>
</h4>

![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/)

0 comments on commit 03e0cdd

Please sign in to comment.