Metadata-Version: 2.4
Name: wikidot
Version: 4.4.0
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/)

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"Title: {page.title}")
print(f"Rating: {page.rating}")
print(f"Author: {page.created_by.name}")
```

## Documentation

For detailed usage, API reference, and examples, please see the official documentation:

**[Official Documentation](https://ukwhatn.github.io/wikidot.py/)**

- [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

- [Roadmap](https://ukwhatn.notion.site/wikidot-py-roadmap?pvs=4)
- [Issue](https://github.com/ukwhatn/wikidot.py/issues)
