Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 25 additions & 25 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,73 +1,73 @@
name: バグ報告
description: バグや不具合を報告する
name: Bug Report
description: Report a bug or issue
title: "[Bug]: "
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
バグ報告ありがとうございます。
以下の項目をできるだけ詳しく記入してください。
Thank you for reporting a bug.
Please fill in the following items as detailed as possible.

- type: textarea
id: description
attributes:
label: 概要
description: バグの内容を簡潔に説明してください
placeholder: どのような問題が発生していますか?
label: Summary
description: Please briefly describe the bug
placeholder: What problem are you experiencing?
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: 再現手順
description: バグを再現する手順を記載してください
label: Steps to Reproduce
description: Please provide steps to reproduce the bug
placeholder: |
1. '...' を実行
2. '...' を呼び出し
3. エラーが発生
1. Execute '...'
2. Call '...'
3. Error occurs
validations:
required: true

- type: textarea
id: expected
attributes:
label: 期待される動作
description: 本来どのように動作すべきかを記載してください
label: Expected Behavior
description: Please describe how it should work
validations:
required: true

- type: textarea
id: actual
attributes:
label: 実際の動作
description: 実際にどのような動作になっているかを記載してください
label: Actual Behavior
description: Please describe the actual behavior
validations:
required: true

- type: textarea
id: environment
attributes:
label: 環境情報
description: 問題が発生した環境を記載してください
label: Environment
description: Please provide your environment details
placeholder: |
- wikidot.py バージョン:
- Python バージョン:
- wikidot.py version:
- Python version:
- OS:
- 実行環境: (Jupyter Notebook / スクリプト / etc.)
- Execution environment: (Jupyter Notebook / script / etc.)
validations:
required: true

- type: textarea
id: logs
attributes:
label: エラーログ・スタックトレース
description: エラーメッセージやスタックトレースがあれば貼り付けてください
label: Error Logs / Stack Trace
description: Please paste any error messages or stack traces if available
render: shell

- type: textarea
id: additional
attributes:
label: 補足情報
description: その他、関連する情報があれば記載してください
label: Additional Information
description: Any other relevant information
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: 質問・ディスカッション
- name: Questions / Discussions
url: https://github.com/ukwhatn/wikidot.py/discussions
about: バグ報告や機能要望以外の質問はこちらへ
about: For questions other than bug reports or feature requests
32 changes: 16 additions & 16 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -1,51 +1,51 @@
name: 機能要望
description: 新機能や改善の提案をする
name: Feature Request
description: Propose a new feature or improvement
title: "[Feature]: "
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
機能要望ありがとうございます。
以下の項目をできるだけ詳しく記入してください。
Thank you for your feature request.
Please fill in the following items as detailed as possible.

- type: textarea
id: problem
attributes:
label: 背景・課題
description: どのような問題を解決したいですか?どのような場面で困っていますか?
placeholder: "例: 〇〇をしたいが、現在の実装では△△ができない"
label: Background / Problem
description: What problem are you trying to solve? What situation are you facing?
placeholder: "Example: I want to do X, but the current implementation doesn't support Y"
validations:
required: true

- type: textarea
id: solution
attributes:
label: 提案する解決策
description: どのような機能や変更があれば解決できると考えますか?
label: Proposed Solution
description: What feature or change would solve this problem?
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: 代替案
description: 他に検討した解決策があれば記載してください
label: Alternatives Considered
description: Have you considered any other solutions?

- type: textarea
id: usecase
attributes:
label: ユースケース
description: この機能がどのように使われるか、具体例があれば記載してください
label: Use Case
description: Please provide a concrete example of how this feature would be used
placeholder: |
```python
# 使用例
# Usage example
client = wikidot.Client()
# ...
```

- type: textarea
id: additional
attributes:
label: 補足情報
description: 参考リンクや関連するIssueなど、その他の情報があれば記載してください
label: Additional Information
description: Reference links, related issues, or any other information
56 changes: 28 additions & 28 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,46 @@
## 概要
## Summary

<!-- このPRの目的・背景を簡潔に説明してください -->
<!-- Please briefly explain the purpose and background of this PR -->

## 関連Issue
## Related Issue

<!-- 関連するIssueがあればリンクしてください -->
<!-- : resolves #123 / fixes #456 / closes #789 -->
<!-- Link any related issues -->
<!-- Example: resolves #123 / fixes #456 / closes #789 -->

## 変更内容
## Changes

<!-- 具体的に何を変更したかを箇条書きで記載してください -->
<!-- Please list the specific changes in bullet points -->

-

## 変更の種類
## Type of Change

<!-- 該当するものにチェックを入れてください -->
<!-- Check all that apply -->

- [ ] バグ修正 (既存の機能を壊さない修正)
- [ ] 新機能 (既存の機能を壊さない追加)
- [ ] 破壊的変更 (既存の機能に影響を与える変更)
- [ ] ドキュメント更新
- [ ] リファクタリング
- [ ] テスト追加・修正
- [ ] CI/CD・ビルド関連
- [ ] Bug fix (non-breaking change that fixes an issue)
- [ ] New feature (non-breaking change that adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
- [ ] Documentation update
- [ ] Refactoring
- [ ] Test addition/modification
- [ ] CI/CD or build related

## テスト
## Testing

<!-- テスト方法や結果を記載してください -->
<!-- Describe how you tested your changes -->

- [ ] `make format` パス
- [ ] `make lint` パス
- [ ] `make test` パス
- [ ] `make format` passes
- [ ] `make lint` passes
- [ ] `make test` passes

## チェックリスト
## Checklist

<!-- PRを出す前に確認してください -->
<!-- Please confirm before submitting -->

- [ ] コードがプロジェクトのスタイルガイドに従っている
- [ ] 必要に応じてドキュメントを更新した
- [ ] 変更に対するテストを追加した(該当する場合)
- [ ] Code follows the project's style guidelines
- [ ] Documentation has been updated as needed
- [ ] Tests have been added for the changes (if applicable)

## 補足情報
## Additional Information

<!-- レビュワーへの伝達事項、スクリーンショット等があれば記載してください -->
<!-- Any additional information for reviewers, screenshots, etc. -->
56 changes: 28 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,67 +2,67 @@

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

Pythonで簡単にWikidotサイトと対話するためのライブラリです。
A Python library for easily interacting with Wikidot sites.

## 主な機能
## Key Features

- サイト、ページ、ユーザー、フォーラムなどの情報取得と操作
- ページの作成、編集、削除
- フォーラムスレッドの取得、作成、返信
- ユーザー管理とサイトメンバーシップ
- プライベートメッセージの送受信
- ログイン不要の機能と認証が必要な機能両方をサポート
- Retrieve and manipulate sites, pages, users, forums, and more
- Create, edit, and delete pages
- Get, create, and reply to forum threads
- User management and site membership
- Send and receive private messages
- Supports both no-login features and authenticated features

## インストール
## Installation

```bash
pip install wikidot
```

## 使用例(基本)
## Basic Usage

```python
import wikidot

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

# サイトとページの情報取得
# Get site and page information
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}")
print(f"Title: {page.title}")
print(f"Rating: {page.rating}")
print(f"Author: {page.created_by.name}")
```

## ドキュメント
## Documentation

詳細な使用方法、APIリファレンス、例は公式ドキュメントをご覧ください:
For detailed usage, API reference, and examples, please see the official documentation:

📚 **[公式ドキュメント](https://ukwhatn.github.io/wikidot.py/)**
**[Official Documentation](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)
- [Installation](https://ukwhatn.github.io/wikidot.py/installation.html)
- [Quickstart](https://ukwhatn.github.io/wikidot.py/quickstart.html)
- [Examples](https://ukwhatn.github.io/wikidot.py/examples.html)
- [API Reference](https://ukwhatn.github.io/wikidot.py/reference/index.html)

## ドキュメント構築
## Building Documentation

ローカルでドキュメントを構築するには:
To build the documentation locally:

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

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

# ローカルサーバーでドキュメントを確認(オプション)
# View documentation on local server (optional)
make docs-serve
```

## Contribution

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