Skip to main content

A lightweight Python library for Store Norske Leksikon and Lex.dk APIs.

Project description

Logo

Actions Status Documentation Status Coverage Status Build Status License: MIT Downloads PyPI

A lightweight Python library for Store Norske Leksikon and Lex.dk APIs

Installation

pip install snldata

Quick Start

Raw JSON

import snldata

R = snldata.SnlSession()
R.search(query="fortolket programmeringsspråk", best=True) #Pick the one with the best rank
print(R.json)

Outputs: the JSON object

{
	"title": "fortolket programmeringsspråk",
	"url": "http://snl.no/fortolket_programmeringsspr%C3%A5k",
	"subject_url": "http://snl.no/.taxonomy/3689",
	"subject_title": "Programmering",
	"xhtml_body": "\u003cdiv\u003e\r\n\u003cp\u003eprogrammeringsspråk som ikke blir kompilert til objekt- eller maskinkode, men fortolket av et eget program på vertsmaskinen.\u003c/p\u003e\r\n\u003cp\u003eFordelen med slike språk er at man kan lage programmer som kan gjøre på mange forskjellige \u003ca class=\"crossref\" href=\"https://snl.no/datamaskin\"\u003edatamaskiner\u003c/a\u003e og \u003ca class=\"crossref\" href=\"https://snl.no/operativsystem\"\u003eoperativsystemer\u003c/a\u003e uten å skreddersy dem for hver enkelt plattform.\u003c/p\u003e\r\n\u003cp\u003eEksempler på fortolkede språk:\u003c/p\u003e\r\n\u003cul\u003e\r\n\u003cli\u003e\u003ca class=\"crossref\" href=\"https://snl.no/Python_-_programmeringsspr%C3%A5k\"\u003ePython\u003c/a\u003e\u003c/li\u003e\r\n\u003cli\u003eJavascript\u003c/li\u003e\r\n\u003cli\u003e\u003ca class=\"crossref\" href=\"https://snl.no/Perl_-_IT\"\u003ePHP\u003c/a\u003e\u003c/li\u003e\r\n\u003cli\u003e\u003ca class=\"crossref\" href=\"https://snl.no/Perl_-_IT\"\u003ePerl\u003c/a\u003e\u003c/li\u003e\r\n\u003c/ul\u003e\r\n\u003c/div\u003e",
	"created_at": "2017-12-12T10:34:18.189+01:00",
	"changed_at": "2017-12-12T10:38:37.626+01:00",
	"license_name": "fri",
	"metadata_license_name": "fri",
	"metadata": {
		"lastname": "",
		"firstname": ""
	},
	"authors": [{
		"full_name": "Henrik Dvergsdal"
	}],
	"images": []
}

Licenses for content from Store Norske Leksikon and Lex.dk

Licence Description Read more
fri Creative Commons CC-BY-SA-3.0 license. Everyone is allowed to share, use, copy and adapt the text as long as the author and Store norske leksikon continues to be credited and the article retains the same free license for further use. Meta
begrenset gjenbruk/begrænset genbrug You can't reuse, republish, or adapt the article without first obtaining the author's permission. Meta

Overview of sites/zones

SNL

code Website Note
snl https://snl.no/ Default
nbl https://nbl.snl.no/
sml https://sml.snl.no/
nkl https://nkl.snl.no/
prototyping - Unstable - for SNL

LEX

code Website Note
dsd https://denstoredanske.lex.dk/
dlh https://dansklitteraturshistorie.lex.dk/
dbl https://biografiskleksikon.lex.dk/
gtl https://teaterleksikon.lex.dk/
nm https://mytologi.lex.dk/
do https://danmarksoldtid.lex.dk/
sl https://symbolleksikon.lex.dk/
dh https://danmarkshistorien.lex.dk/
hob https://bornelitteratur.lex.dk/
pd https://pattedyratlas.lex.dk/
prototyping-lex - Unstable - for LEX pages

Query

Easy Query

import snldata

R = snldata.SnlSession()
R.search(query="Ole Ivars", best=True) #Pick the one with the best rank
print(R.url)

Outputs: https://snl.no/Ole_Ivars

import snldata

R = snldata.SnlSession()
R.search(query="Ole Ivars") #Pick the three best results
for val in R.json:
    print(val["simple"] #Summery for each index

Outputs:

0. Ole Ivars (rank 576.6): Ole Ivars er et norsk danseband fra Hamar.
1. Spellemannprisen (rank 25.9): Spellemannprisen er den norske platebransjens årlige prisutdeling for å stimulere og markere plateproduksjonen i Norge.
2. danseband (rank 25.1): Danseband, ensemble som spiller til dans, betegner i dag vanligvis en instrumentbesetning som i pop og rock (vokal, elektrisk gitar og bass, keyboards, trommer, eventuelt også saksofon eller andre blåsere).
###Explaining of the values:
<index of the json file> <title> (rank <rank id>): <first sentence>

Pick the article you want from the example above:

R._get(1)
print(R.title)

Outputs: Spellemannprisen

import snldata

R = snldata.SnlSession()
R.search(zone='dsd', query="Python", best=True)  #Pick the one with the best rank
print(R.url)

Outputs: https://denstoredanske.lex.dk/Python

Advance Query (best for prototyping api)

import snldata

R = snldata.SnlSession()
R.searchV2({"encyclopedia": "snl", "query": "dr. dre", "limit": 3, "offset": 0 }, zone="prototyping", best=True)
print(R.title)

Outputs: Dr. Dre

import snldata

R = snldata.SnlSession()
R.searchV2({"encyclopedia": "snl", "query": "dr. dre", "limit": 3, "offset": 0 }, zone="prototyping")
i = 0
for val in R.json:
    print('{}. {}: {}'.format(i, val['headword'], val["query_quality_explain"]))
    i += 1

Outputs:

0. Dr. Dre: The search string is equal to the article's headword and there is no further clarification
1. hiphop: Match on article text or part of title
2. Eminem: Match on article text or part of title
###Explaining of the values: (the prototyping api allows you to send a lot of parametres)
<index of the json file> <title>: <rank as text>

Pick the article you want from the example above:

R._get(1)
print("Title: {}, Created: {}".format(R.title, R.created_at))

Outputs: Title: hiphop, Created: 2009-02-14T05:15:20.546+01:00

No result

If the API returns no results, .json will be given a empty list.

import snldata

R = snldata.SnlSession()
R.search(zone='dsd', query="asdadasdasdad", best=True)  #Pick the one with the best rank
print(R.json)

Outputs: []

All of the examples uses text that is CC-BY-SA-3.0. By at least one of the following authors: Henrik Dvergsdal, Jon Vidar Bergan, and Audun Kjus Aahlin. Read more about the license: fri gjenbruk.

To-do

  • <input type="checkbox" disabled="" /> Fully support taxonomy
  • <input type="checkbox" disabled="" /> When zero results, return somthing to tell the user there is no result.

Reporting Issues

If you have suggestions, bugs or other issues specific to this library, file them here. Or just send me a pull request.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for SnlData, version 1.1.0
Filename, size File type Python version Upload date Hashes
Filename, size SnlData-1.1.0-py3-none-any.whl (20.3 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size SnlData-1.1.0.tar.gz (8.8 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page