Currently WIP, but this project works.
I wrapper for the Wikipedia and Wikimedia API to get commonly used things.
It's constantly changing, but my main focus is working on new features and making QOL changes to make it nicer to work with.
Install as a shard by including in your shards.yml
dependencies:
crwikilib:
github: MaterialFuture/CrWikiLibAfter adding remember to run shards to install and be able to use in your project
Refer to examples/ directory for examples of use.
To get the page in a data format use the following:
puts Wiki::Page.new("https", "Crystal_(programming_language)", "json")To get the page as a PDF for download use the following:
puts Wiki::Page.pdf("https", "Crystal_(programming_language)")To get the Post of the Day use the following code: (date in ISO format)
Wiki::POTD.new("HTTPS", potd_date, "json")I made it so you can specify protocol, that way if you're not required HTTP or HTTPS, you dsecide.
TODO: Write development instructions here
- Fork it (https://github.com/materialfuture/wiki-api/fork)
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request
- MaterialFuture - creator and maintainer
- Example PDF Request to Rest API: https://en.wikipedia.org/api/rest_v1/page/pdf/Rust_(programming_language)
- Look into adding Admiral Shard
- Look into adding functionality for reading txt file for bulk downloads for PDFs
- Breakout URLs for so they're more reusable