Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hay/wikilope
Discover interesting connections starting from a Wikipedia article
https://github.com/hay/wikilope
graph-theory network-analysis nodejs wikipedia wikipedia-api
Last synced: 3 months ago
JSON representation
Discover interesting connections starting from a Wikipedia article
- Host: GitHub
- URL: https://github.com/hay/wikilope
- Owner: hay
- License: mit
- Created: 2018-09-17T15:27:09.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-09-17T21:57:22.000Z (over 6 years ago)
- Last Synced: 2024-10-07T07:09:34.040Z (3 months ago)
- Topics: graph-theory, network-analysis, nodejs, wikipedia, wikipedia-api
- Language: JavaScript
- Size: 26.4 KB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# wikilope
> Discover interesting connections starting from a Wikipedia article.
This is a Node.js library and command-line tool to see connections from Wikipedia articles. For example, you can use it to see the [Getting to Philosophy](https://en.wikipedia.org/wiki/Wikipedia:Getting_to_Philosophy) effect, but it can do much more.
## Install
```
$ npm install -g wikilope
```
## Basic usage
On the command line
```bash
wikilope -l -a
```
Or using a script
```javascript
const Wikilope = require('../index.js');
const lope = new Wikilope({
article : '',
language : ''
});
lope.run();
```
## Advanced usage
### Command line
The `wikilope` command has a lot of options you can use for interesting queries:
```bash
Usage: wikilope [options] [env]
Options:
-a, --article Wikipedia article name
-c, --count Number of links to fetch
-f, --format Output format: 'tree' (default) or 'terms'
--json Output in JSON format
-l, --language Language code for Wikipedia edition (e.g. 'en', 'nl', 'fr')
--no-redirects Don't follow redirects
--no-cache Don't cache entries
-r, --recursive Also crawl up from results
-s, --steps How many steps should we go up?
-v, --verbose
-h, --help output usage information
```
Here's the classical [Getting to Philosopy](https://en.wikipedia.org/wiki/Wikipedia:Getting_to_Philosophy) effect, starting from the English language Wikipedia version of the 'Amsterdam' article.
wikilope -l en -a Amsterdam
Let's not just get the first link, but the first three links. And let's use the German Wikipedia.
wikilope -l de -a Amsterdam -c 3
To also get the links from the articles you find use the recursive (`-r`) option.
wikilope -l en -a Elephant -r
Get the same data, but in JSON format
wikilope -l en -a Elephant -r --json
To limit the number of articles we're getting we could use the step (`-s`) option. We're also getting the first three links and doing it recursive.
wikilope -l en -a Blockchain -rs 5 -c 3
### Node.js
Use this module for Node.js like this:
```javascript
const Wikilope = require('../index.js');
const lope = new Wikilope({
article : 'Amsterdam',
language : 'en'
});
lope.run();
```
All options of the command line version have equivalent arguments in the `Wikilope` constructor:
```javascript
{
// Class option : Command line flag
article : article,
count : count,
debug : verbose,
followRedirects : redirects,
format : format,
json : json,
language : language,
recursive : recursive,
steps : steps,
useCache : cache
}
```
## License
MIT © [Hay Kranen](http://www.haykranen.nl)