#go #open #cli-tool #kr

app ogk

用于 open.go.kr 的 CLI 工具

10 个版本 (稳定版)

2.0.0 2024年5月1日
1.2.2 2024年5月1日
1.2.1 2022年7月17日
1.1.0 2022年4月11日
0.1.1 2022年3月5日

#125认证

自定义许可证

75KB
2K SLoC

ogk - 用于 open.go.kr 的 CLI 工具

如果您有 信息公开门户 账户并且经常使用该平台,则该项目可以帮助您比官方网站更方便地管理数据和文件。

赞助

安装

: 目前 ogk 可以通过 HomebrewCargo 进行安装。

homebrew
brew tap opengirok/ogk
brew install ogk
cargo
cargo install ogk

设置

# 1. 계정 설정
# 정보공개플랫폼 계정 설정(open.go.kr에 등록된 계정이어야 합니다.)
ogk auth login --username <username> --password <password>


# 2. 파일 관리 설정
# 내컴퓨터에 저장할 파일 위치를 지정합니다.
# 기본값: ~/.ogk/.data
ogk config files --local-repository /Path/to/local/repository

# 3.에서 생성한 원격저장소 주소를 지정합니다.
# 현재 버전(v0.1)에서는 원격저장소가 반드시 지정되어야 파일 관리가 가능합니다.
# 예: ogk config files --remote-repository hoonyland/data
ogk config files --remote-repository <user_or_org-name/repository_name>

# 3. supabase (데이터베이스) 설정
# [Supabase 설정하기](docs/supabase.md) 문서를 참고하여 Supabase 설정을 먼저 완료하시길 바랍니다.
# 위 설정 후 Supabase에서 발급받은 host, api key를 등록합니다.
ogk config sync --supabase-host https://****.supabase.co
ogk config sync --supabase-api-key ****

# 4. SLACK 알림 설정
# Slack Webhook을 생성한 뒤 URL을 설정합니다.
# 각 명령 뒤에 `--with-slack-notification true` 를 붙이면 슬랙 알림이 함께 갑니다.
ogk config integration --slack-webhook-url https://****.slack.com

文件管理需求
  1. git 安装和账户设置
  2. GitHub SSH 认证设置 - 官方文档参考博客
  3. 创建远程仓库

使用

1. 查询
  • 按日期和页面单位查询
ogk fetch bills --from 2021-01-01 --to 2020-12-31 --page 1
2. 下载文件

: 在 设置 中先行进行文件管理的设置。

ogk download --from 2021-01-01 --to 2021-12-31
3. 查询和保存数据

: 在 设置 中先行进行 supabase 注册和设置。


# 1. 기본 조회 및 저장
ogk sync --from 2021-01-01 --to 2021-12-31

# 2. 현재 설정된 Supabase 데이터베이스에서 통지완료되지 않은 건들만 새로 업데이트
# `--from`과 `--to` 옵션을 지정하지 않습니다.
ogk sync

故障排除

  1. 在 Ubuntu 环境中,需要安装 pkg-configlibssl-dev
    sudo apt-get install pkg-config libssl-dev
    

路线图

1. 账户安全
  • 强化 open.go.kr 账户管理安全

外部库

贡献者

hoony

许可证

MIT 许可证

依赖项

~24–37MB
~623K SLoC