Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fastily/jwiki

📖 A library for effortlessly interacting with Wikipedia/MediaWiki
https://github.com/fastily/jwiki

java mediawiki mediawiki-api mediawiki-bot mediawiki-client wikipedia wikipedia-api

Last synced: 2 days ago
JSON representation

📖 A library for effortlessly interacting with Wikipedia/MediaWiki

Host: GitHub
URL: https://github.com/fastily/jwiki
Owner: fastily
License: gpl-3.0
Created: 2015-08-27T05:54:27.000Z (about 9 years ago)
Default Branch: master
Last Pushed: 2023-06-26T01:34:03.000Z (over 1 year ago)
Last Synced: 2024-09-21T09:02:13.983Z (7 days ago)
Topics: java, mediawiki, mediawiki-api, mediawiki-bot, mediawiki-client, wikipedia, wikipedia-api
Language: Java
Homepage:
Size: 3.38 MB
Stars: 109
Watchers: 11
Forks: 31
Open Issues: 1
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md

Awesome Lists containing this project

README

        # jwiki

[![Build Status](https://github.com/fastily/jwiki/workflows/build/badge.svg)](#)

[![javadoc](https://javadoc.io/badge2/io.github.fastily/jwiki/javadoc.svg)](https://javadoc.io/doc/io.github.fastily/jwiki)

[![JDK-11+](https://upload.wikimedia.org/wikipedia/commons/e/ef/Blue_JDK_11%2B_Shield_Badge.svg)](https://adoptium.net)

[![MediaWiki 1.31+](https://upload.wikimedia.org/wikipedia/commons/b/b2/Blue_MediaWiki_1.31%2B_Shield_Badge.svg)](https://www.mediawiki.org/wiki/MediaWiki)

[![License: GPL v3](https://upload.wikimedia.org/wikipedia/commons/8/86/GPL_v3_Blue_Badge.svg)](https://www.gnu.org/licenses/gpl-3.0.en.html)

Programmatically accessing [Wikipedia](https://en.wikipedia.org/wiki/Main_Page)/[MediaWiki](https://www.mediawiki.org/wiki/MediaWiki) via the [API](https://en.wikipedia.org/w/api.php) is hard ☹️.  I thought it didn't have to be, so I made it easy 😀.  jwiki lets you perform all sorts of crazy API calls with 1️⃣ line of Java.  

Yes, **one** line.  

It's so easy that _anyone_ (including your grandma 👵🏻) can write a program that works with MediaWiki.

Not convinced?  Try out the [examples](https://github.com/fastily/jwiki/wiki/Examples).

## Download

#### Maven

```xml

  io.github.fastily

  jwiki

  1.11.0

```

#### Gradle

```groovy

implementation 'io.github.fastily:jwiki:1.11.0'

```

⚠️ COORDINATES HAVE CHANGED (since 1.10.0): jwiki's new group id is `io.github.fastily`

## Build

Build and publish (install) jwiki on your computer with

```bash

./gradlew publishToMavenLocal -x signMavenJavaPublication

```

## Resources

* [Examples](https://github.com/fastily/jwiki/wiki/Examples)

* [Javadocs](https://www.javadoc.io/doc/io.github.fastily/jwiki)

Please create a new [issue](https://github.com/fastily/jwiki/issues) for bug reports and/or feature requests.

## Goals

* **Simplicity** - Complex objects and functions are abstracted into the background so that anybody, regardless of Java experience, will be able to use jwiki.

* **Speed** - Network calls, local computation, and memory usage are optimized and minimized, so as to enhance performance and reduce overhead.

* **Succinctness** - Complex API actions can be performed in jwiki using one line of local code consisting of simple objects and primitive types.