Socket
Socket
Sign inDemoInstall

@roberto0arruda/wikipedia-api

Package Overview
Dependencies
36
Maintainers
1
Versions
1
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @roberto0arruda/wikipedia-api

a Wikipedia Api Wrapper with Node


Version published
Weekly downloads
1
Maintainers
1
Install size
2.12 MB
Created
Weekly downloads
 

Readme

Source

A Node.js Bot that search for content with Wikipedia's Api

This bot will prompt you asking for a keyword, then it will search and fetch content from Wikipedia.


How to start

  1. Clone this repository, navigate do repo folder and Install it.
git clone https://github.com/maykbrito/wikipedia-api-node.git && cd wikipedia-api-node && npm install
  1. Once it is installed, run with
npm run start

You will see an interactive prompt to help you search your content.

Imgur


Language & Translations

By default language for search in Wikipedia is Portuguese. You can change it by opening ./language.json and change "lang":"pt" to your own language.

Note: If it's not English you will need to provide your own translation.

For example: If your language is French, Just copy this snippet bellow, and start your translation.

"fr": {
    "askForSearchTerm": "Type your search term",
    "confirmOrSelectSearchTerm": "Confirm Your Term Search or Select One",
    "fetchingImages": "Fetching Images",
    "fetchingContent": "Fetching Content",
    "errorWaitingWikipediaContent": "Error waiting for content",
    "errorFetchingImage": "Could Not Fetch Image Url From Wikipedia",
    "errorFetchingContent": "Could Not Fetch Content From Wikipedia",
    "errorFetchingTerms": "Could Not Fetch Terms From Wikipedia",
    "exitWithDefault": "Exiting Program",
    "exitWithEmptyResults": "Your search term don't return any result",
    "exitWithKeyNotSelected": "You don't selected any key"
}

And change bot to your language

"lang":"fr"

If you want to, just change the language like above and Wikipedia will search in that language

FYI:

  • In case of you don't provide any translation, this bot will be prompted in English

  • To select a language follow this pattern* http://www.lingoes.net/en/translator/langcode.htm

  • Wikipedia Api don't work with all avaiable languages


How to use it in your project (without my interactive prompt)

You will need to clone and install it in your project folder.

Initiate it

const wikipedia = require('./wikipedia');

Your wikipedia will require this object

content = {
    searchTerm = "Your Search Term here"
}

Then you can await for search

await wikipedia(content);

Your content object will return like this:

content = {
    searchTerm = "",
    wikipediaContent = {
        pageid: '',
        title: '',
        url: '',
        raw: '',
        summary: '',
        references: [],
        images: [],
    }
}

I still don't know how to make a npm package to helping us. (if you want to, we all will be thankful)

It's free (MIT license) © Mayk Brito

FAQs

Last updated on 23 Mar 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc