Skip to main content

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

Project description

Logo

SnlData version Actions Status Documentation Status Coverage Status Build Status License: GPLv3 Downloads PyPI

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

Installation

pip3 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. SNL LEX
begrenset gjenbruk/begrænset genbrug You can't reuse, republish, or adapt the article without first obtaining the author's permission. SNL LEX

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/
lille https://lille.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/
nid https://naturenidanmark.lex.dk/
trap https://trap.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)

The prototyping API endpoint has been removed as of May 2023.

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: {}

import snldata

R = snldata.SnlSession()
R.search(zone='dsd', query="jdfhdskjfhsjkdfhksdfh") #Pick the three best results, but there are none
R._get(0)
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

  • Fully support taxonomy
  • Support for ".recent-activities" to JSON.
  • When zero results, return empty dict 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.

Source Distribution

snldata-1.1.3.tar.gz (21.5 kB view details)

Uploaded Source

Built Distribution

SnlData-1.1.3-py3-none-any.whl (20.4 kB view details)

Uploaded Python 3

File details

Details for the file snldata-1.1.3.tar.gz.

File metadata

  • Download URL: snldata-1.1.3.tar.gz
  • Upload date:
  • Size: 21.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for snldata-1.1.3.tar.gz
Algorithm Hash digest
SHA256 5b84fb6a8ad41dfa4a132d6b742365047c2df10f1ff84a801b433c6632cecb62
MD5 d802cd8b06baac7e725de30efd5b283d
BLAKE2b-256 c98dc1f75fcd1b7ef09698e0510ee0482697d16dabd4ad0e016c677beff55def

See more details on using hashes here.

File details

Details for the file SnlData-1.1.3-py3-none-any.whl.

File metadata

  • Download URL: SnlData-1.1.3-py3-none-any.whl
  • Upload date:
  • Size: 20.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for SnlData-1.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 1963e579385fa961ddde32dfef3b57f6ed1e3251ba513900ef89247db8198f02
MD5 066e1749d1181c1134affaa76562ab5b
BLAKE2b-256 4c1537043d71d51653c3678df8a1d68459b60b130637c26c2c0972f88efbe712

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page