chouseisan-pyというPythonライブラリを作りました

調整さんのイベント作成をPythonコード上から行えるライブラリchouseisan-pyを作りました。

以下の方法でインストールできます。

1
$ pip install chouseisan-py

現在のバージョン0.1.0では、イベントの作成しかサポートしていません。使い方は以下のとおりです。

1
2
3
4
5
6
7
8
9
>>> from datetime import datetime
>>> from chouseisan_py.chouseisan import Auth, Chouseisan
>>> auth = Auth(email="test@example.com", password="<secret>")
>>> chouseisan = Chouseisan(auth)
>>> chouseisan.create_event(
...    title="test event",
...    candidate_days=[datetime(2021, 10, 17, 19, 0), datetime(2021, 10, 18, 19, 0)]
... )
'https://chouseisan.com/s?h=f7b7fc11995b441782844bc3fddaf456'

ソースコードは以下に置いてあります。

https://github.com/ryu22e/chouseisan_py

調整さんにはAPIがないので、中でやっているのはrequestsとbeautifulsoup4を使ったスクレイピングです。

以下で、開発で利用したライブラリ・ツールについて紹介します。

poetry

公式サイト： https://python-poetry.org/

Pythonのパッケージマネージャーです。 poetry publishでPyPIにデプロイする機能が便利そうだったので採用しました。

black

公式サイト： https://black.readthedocs.io/en/stable/

ソースコードを自動整形してくれるツールです。 GitHub ActionsとGitのpre-commitスクリプトで呼んで、blackで整形していないファイルがあればエラーにしています。

blackについて詳しくは以下の記事が参考になります。

もうPythonの細かい書き方で議論しない。blackで自動フォーマットしよう - Make組ブログ

flake8

公式サイト： https://flake8.pycqa.org/en/latest

Pythonコードが規約通りに書かれているかチェックするツールです。前述のblackを使っていてもflake8的にエラーになるケースがあるので、併用しています。 GitHub ActionsとGitのpre-commitスクリプトでも呼ぶようにしています。

mypy

公式サイト： http://www.mypy-lang.org/

Pythonの型チェックを行ってくれるツールです。 requestsやbeautifulsoup4には型ヒントが書かれていないのですが、types-requestsやtypes-beautifulsoup4をインストールすることで型チェックができます。 mypyのおかげでNoneが返ってくる可能性があるコードなのにNoneに定義されていないメソッドを呼んでいる、といった不具合に早く気付くことができました。 GitHub ActionsとGitのpre-commitスクリプトでも呼ぶようにしています。