Metadata-Version: 2.1
Name: tuat-feed
Version: 0.2.1
Summary: Unofficial library for fetching the feed for TUAT
Home-page: https://github.com/pineapplehunter/tuat-feed
License: MIT
Author: Shogo Takata
Author-email: s196643z@st.go.tuat.ac.jp
Requires-Python: >=3.7,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: requests (>=2.26.0,<3.0.0)
Project-URL: Repository, https://github.com/pineapplehunter/tuat-feed
Description-Content-Type: text/markdown

# (非公式)TUAT掲示板ライブラリ

## インストール
* `python` >= 3.7

```sh
$ pip install tuat-feed
```

## 使い方

```python
>>> import tuat_feed
>>> feed = tuat_feed.fetch()
>>> len(feed)
40
>>> feed[0]
Post(...)
```

### fetch
`fetch()`を使って投稿情報をダウンロードします。結果は`Post`の配列になっています。
### Post

`Post`の定義はかんたんに書くと次のようになっています。

```python
class Post:
    post_id: int  # 投稿ID（内部処理用）
    title: str  # タイトル
    description: str  # 本文
    update_date: date  # 最終更新日
    show_date: (date, date)  # 公開期間
    author: str  # 担当者
    origin: str  # 発信元
    category: str  # カテゴリー
    attachment: List[Attachment]  # 添付ファイル
    other: Dict[str, str]  # その他のフィールド
```

### Attachment

`Attachment`の定義はかんたんに書くと次のようになっています。

```python
class Attachment:
    name: str  # ファイル名
    url: str  # URL
```
