Skip to content
/ jwiki Public

📖 A library for effortlessly interacting with Wikipedia/MediaWiki

License

Notifications You must be signed in to change notification settings

fastily/jwiki

Repository files navigation

jwiki

Build Status javadoc JDK-11+ MediaWiki 1.31+ License: GPL v3

Programmatically accessing Wikipedia/MediaWiki via the API 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.

Download

Maven

<dependency>
  <groupId>io.github.fastily</groupId>
  <artifactId>jwiki</artifactId>
  <version>1.11.0</version>
</dependency>

Gradle

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

./gradlew publishToMavenLocal -x signMavenJavaPublication

Resources

Please create a new issue 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.