Metadata-Version: 2.4
Name: wikidot
Version: 4.0.2
Summary: Wikidot Utility Library
Project-URL: Homepage, https://github.com/ukwhatn/wikidot.py
Project-URL: Bug Tracker, https://github.com/ukwhatn/wikidot.py/issues
Author-email: ukwhatn <ukwhatn@gmail.com>
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.10
Requires-Dist: beautifulsoup4<4.15.0,>=4.12.2
Requires-Dist: httpx<0.29,>=0.25
Requires-Dist: lxml<6.1.0,>=4.9.3
Requires-Dist: typing-extensions>=4.5.0; python_version < '3.12'
Provides-Extra: build
Requires-Dist: build; extra == 'build'
Requires-Dist: twine; extra == 'build'
Provides-Extra: dev
Requires-Dist: pre-commit>=3.6.0; extra == 'dev'
Provides-Extra: format
Requires-Dist: ruff; extra == 'format'
Provides-Extra: lint
Requires-Dist: lxml-stubs; extra == 'lint'
Requires-Dist: mypy; extra == 'lint'
Requires-Dist: ruff; extra == 'lint'
Requires-Dist: types-beautifulsoup4; extra == 'lint'
Provides-Extra: test
Requires-Dist: pytest-asyncio>=0.23.0; extra == 'test'
Requires-Dist: pytest-cov>=4.1.0; extra == 'test'
Requires-Dist: pytest-httpx>=0.35.0; extra == 'test'
Requires-Dist: pytest>=8.0.0; extra == 'test'
Description-Content-Type: text/markdown

# wikidot.py

[![Documentation Status](https://github.com/ukwhatn/wikidot.py/actions/workflows/docs.yml/badge.svg)](https://ukwhatn.github.io/wikidot.py/)

Pythonで簡単にWikidotサイトと対話するためのライブラリです。

## 主な機能

- サイト、ページ、ユーザー、フォーラムなどの情報取得と操作
- ページの作成、編集、削除
- フォーラムスレッドの取得、作成、返信
- ユーザー管理とサイトメンバーシップ
- プライベートメッセージの送受信
- ログイン不要の機能と認証が必要な機能両方をサポート

## インストール

```bash
pip install wikidot
```

## 使用例（基本）

```python
import wikidot

# ログインなしでの使用
client = wikidot.Client()

# サイトとページの情報取得
site = client.site.get("scp-jp")
page = site.page.get("scp-173")

print(f"タイトル: {page.title}")
print(f"評価: {page.rating}")
print(f"作成者: {page.created_by.name}")
```

## ドキュメント

詳細な使用方法、APIリファレンス、例は公式ドキュメントをご覧ください：

📚 **[公式ドキュメント](https://ukwhatn.github.io/wikidot.py/)**

- [インストール方法](https://ukwhatn.github.io/wikidot.py/installation.html)
- [クイックスタート](https://ukwhatn.github.io/wikidot.py/quickstart.html)
- [使用例](https://ukwhatn.github.io/wikidot.py/examples.html)
- [APIリファレンス](https://ukwhatn.github.io/wikidot.py/reference/index.html)

## ドキュメント構築

ローカルでドキュメントを構築するには:

```bash
# ドキュメント生成に必要なパッケージをインストール
make docs-install

# ドキュメントをビルド
make docs-build

# ローカルサーバーでドキュメントを確認（オプション）
make docs-serve
```

## Contribution

- [ロードマップ](https://ukwhatn.notion.site/wikidot-py-roadmap?pvs=4)
- [Issue](https://github.com/ukwhatn/wikidot.py/issues)
