Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cxuesong/wikiclientlibrary
/*🌻*/ Wiki Client Library is an asynchronous MediaWiki API client library targeting modern .NET platforms
https://github.com/cxuesong/wikiclientlibrary
cargo fandom fandom-wiki mediawiki mediawiki-api mediawiki-bot scribunto structured-discussion wikia wikia-api wikibase wikidata wikidata-bot
Last synced: 2 days ago
JSON representation
/*🌻*/ Wiki Client Library is an asynchronous MediaWiki API client library targeting modern .NET platforms
- Host: GitHub
- URL: https://github.com/cxuesong/wikiclientlibrary
- Owner: CXuesong
- License: apache-2.0
- Created: 2016-08-18T06:05:54.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-09-02T14:59:44.000Z (25 days ago)
- Last Synced: 2024-09-26T05:23:25.283Z (2 days ago)
- Topics: cargo, fandom, fandom-wiki, mediawiki, mediawiki-api, mediawiki-bot, scribunto, structured-discussion, wikia, wikia-api, wikibase, wikidata, wikidata-bot
- Language: C#
- Homepage: https://github.com/CXuesong/WikiClientLibrary/wiki
- Size: 64.4 MB
- Stars: 80
- Watchers: 7
- Forks: 16
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
README
# Wiki Client Library
[](https://github.com/CXuesong/WikiClientLibrary/actions/workflows/ci.yml) [](https://gitter.im/CXuesong/WikiClientLibrary?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
A hand-crafted asynchronous [MediaWiki](https://www.mediawiki.org/) API client library for wiki sites (including [Wikipedia](https://www.wikipedia.org/) and its sister projects, as well as [FANDOM]() and [Wikia.org](). The library targets at .NET 6.0 & 8.0 (See [Supported Platforms](https://docs.microsoft.com/en-us/dotnet/standard/net-standard#net-platforms-support)), and focuses on the API compatibility with MediaWiki 1.19, as well as the state-of-art APIs of MediaWiki (i.e. 1.34-wmf, as in 2019-05). Other versions in between are hopefully also compatible.
> For migrated FANDOM sites on MW 1.33+ (See [UCP migration post](https://community.fandom.com/wiki/User_blog:MisterWoodhouse/The_first_migrations_to_the_Unified_Community_Platform)), you may need to use Bot Password in order to login successfully.
> If you are on prior versions of .NET Core or .NET Framework, you may use prior version of the WCL packages.
> * WCL v0.7.x libraries target .NET Standard 1.1 and has dependency on `Newtonsoft.Json`
> * WCL v0.8.x libraries target .NET Standard 2.1, .NET 6.0 & .NET 8.0, and has dependency on `Newtonsoft.Json`
The packages `CXuesong.MW.WikiClientLibrary.*` are now available on NuGet. E.g. you may install the main package using the following command
```powershell
# Package Management Console
Install-Package CXuesong.MW.WikiClientLibrary
# .NET CLI
dotnet add package CXuesong.MW.WikiClientLibrary
```
| Package | Status |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| [CXuesong.MW.WikiClientLibrary](https://www.nuget.org/packages/CXuesong.MW.WikiClientLibrary) |   |
| [CXuesong.MW.WikiClientLibrary.Cargo](https://www.nuget.org/packages/CXuesong.MW.WikiClientLibrary.Cargo) |  |
| [CXuesong.MW.WikiClientLibrary.Flow](https://www.nuget.org/packages/CXuesong.MW.WikiClientLibrary.Flow) |   |
| [CXuesong.MW.WikiClientLibrary.Wikia](https://www.nuget.org/packages/CXuesong.MW.WikiClientLibrary.Wikia) |   |
| [CXuesong.MW.WikiClientLibrary.Wikibase](https://www.nuget.org/packages/CXuesong.MW.WikiClientLibrary.Wikibase) |   |
If you bump into bugs, have any suggestions or feature requests, feel free to open an issue. Any contributions on documentations (code annotations & repository wiki) are also welcomed. Thank you.
## See also
* [Repository Wiki](https://github.com/CXuesong/WikiClientLibrary/wiki) (getting started & conceptual documentations)
* [Library Documentation](https://cxuesong.github.io/WikiClientLibrary) (for latest pre-release)
* [FuGet Gallery](https://www.fuget.org/packages/CXuesong.MW.WikiClientLibrary) (inspect & diff public API)
* [Releases](https://github.com/CXuesong/WikiClientLibrary/releases)
## Overview
Developed in Visual Studio 2019, this portable & asynchronous MediaWiki API client provides an easy and asynchronous access to commonly-used MediaWiki API. The library has the following features
* Queries for and edits to pages, categories, and files; page information inspection; file uploading.
* Login/logout via simple asynchronous functions.
* Client code has access to `CookieContainer`, and therefore has chance to persist it.
* Tokens are encapsulated in the library functions, so that client won't bother to retrieve them over and over again.
* Query continuations are encapsulated by `IAsyncEnumerable`, which will ease the pain when using page generators.
* Other miscellaneous MediaWiki API, such as
* OpenSearch
* Page parsing
* Patrol
* Scribunto Lua console and server-side module execution support
* StructuredDiscussions (aka. Flow) support
* Basic Wikibase (Wikidata's back-end) API support; the library provides facility to consume Wikibase JSON dump
* Basic FANDOM / Wikia API (Nirvana, Wikia AJAX, and Wikia REST-ful API v1) support