Metadata-Version: 2.1
Name: velog-hits
Version: 1.0.0
Summary: Velog Hits
Home-page: https://github.com/insutance/velog-hits
Author: insutance
Author-email: insutance@naver.com
License: UNKNOWN
Platform: UNKNOWN
Requires-Python: >= 3.8
Description-Content-Type: text/markdown
Requires-Dist: pandas
Requires-Dist: requests

# 🍕 velog-hits
**velog-hits**는 자신의 velog 게시글 조회수 통계를 종합해서 한 눈에 보기 쉽도록 HTML 파일로 만들어주는 프로젝트입니다.

## 📍 Demo Image
![Demo Image](./demo.png)

## 📍 시작하기
### 1) 파이썬 버전
- Python >= 3.8

### 2) 설치
- 조회수 종합 통계 데이터를 저장할 폴더 생성
  ```shell
  $ mkdir velog-hits-data
  ```

- 생성한 폴더로 이동
  ```shell
  $ cd velog-hits-data
  ```

- pip 설치
  ```shell
  $ pip install velog-hits
  ```

## 📍 사용방법
### 1) 도움말 명령어
```shell
$ velog-hits -h
```
```shell
usage: velog-hits [-h] -u USERNAME -at ACCESSTOKEN

Velog Hits

optional arguments:
  -h, --help            show this help message and exit
  -u USERNAME, --username USERNAME
                        Velog Username
  -at ACCESSTOKEN, --accesstoken ACCESSTOKEN
                        Your Velog Access Token
```

### 2) Velog Hits 실행

> ⚠️ Access Token을 모르신다면 해당 기능을 사용하실 수 없습니다.

Velog Hits를 사용하기 위해서는 자신의 **Velog Username(=ID)** 와 **Access Token**이 필요합니다.</br>
"조회수 통계"는 로그인 했을 때만 볼 수 있는 기능이기 때문에 Access Token이 필요합니다. Access Token을 통해 본인임을 인증할 수 있습니다.</br> 


```shell
$ velog-hits -u {username} -at {access_token}
```
```shell
'{username}'님의 조회수 데이터를 가져오고 있으니 잠시만 기다려주세요:)
'{username}'님의 조회수 데이터를 모두 가져왔습니다!!
HTML로 변환을 시작합니다...
Velog Hits Success!!
Velog Hits Result: {오늘날짜.html 파일 위치 경로}
```

### 3) 결과 확인
결과로 나온 `{오늘날짜.html 파일 위치 경로}` 부분을 복사한 후 **웹 브라우저를 열고 주소창에** 붙여넣기합니다.

조회수 종합 통계 데이터는 `.../velog-hits-data/htmlhits/`에 저장됩니다.</br>
- 명령어를 실행시킨 위치에 `htmlhits/` 폴더가 생성되고 `htmlhits/오늘날짜.html 파일`이 생성됩니다.
- 그렇기 때문에 `시작하기-설치` 부분에서 데이터 저장 폴더를 생성하고 해당 폴더로 이동한 것입니다.


