Skip to main content

Python client for Nanopub

Project description

Build Status Documentation Status Coverage Status PyPI version CII Best Practices fair-software.eu DOI

nanopub

The nanopub library provides a high-level, user-friendly python interface for searching, publishing and retracting nanopublications.

Nanopublications are a formalized and machine-readable way of communicating the smallest possible units of publishable information. See the documentation for more information.

Documentation

Checkout the user documentation

Setup

Install using pip:

pip install nanopub

To publish to the nanopub server you need to setup your profile. This allows the nanopub server to identify you. Run the following command in the terminal:

setup_nanopub_profile

This will ask you a few questions, then it will use that information to add and store RSA keys to sign your nanopublications with, (optionally) publish a nanopublication with your name and ORCID iD to declare that you are using these RSA keys, and store your ORCID iD to automatically add as author to the provenance of any nanopublication you will publish using this library.

Quick Start

Publishing nanopublications

from nanopub import Publication, NanopubClient
from rdflib import Graph, URIRef, RDF, FOAF

# Create the client, that allows searching, fetching and publishing nanopubs
client = NanopubClient()

# Either quickly publish a statement to the server
client.claim('All cats are gray')

# Or: 1. construct a desired assertion (a graph of RDF triples)
my_assertion = Graph()
my_assertion.add( (URIRef('www.example.org/timbernerslee'), RDF.type, FOAF.Person) )

# 2. Make a Publication object with this assertion
publication = Publication.from_assertion(assertion_rdf=my_assertion)

# 3. Publish the Publication object. The URI at which it is published is returned.
publication_info = client.publish(publication)
print(publication_info)

Searching for nanopublications

from nanopub import NanopubClient

# Search for all nanopublications containing the text 'fair'
results = client.find_nanopubs_with_text('fair')
print(results)

Fetching nanopublications and inspecting them

# Fetch the nanopublication at the specified URI
publication = client.fetch('http://purl.org/np/RApJG4fwj0szOMBMiYGmYvd5MCtRle6VbwkMJUb1SxxDM')

# Print the RDF contents of the nanopublication
print(publication)

# Iterate through all triples in the assertion graph
for s, p, o in publication.assertion:
    print(s, p, o)

Dependencies

The nanopub library currently uses the nanopub-java tool for signing and publishing new nanopublications. This is automatically installed by the library.

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

nanopub-1.2.11.tar.gz (9.6 MB view details)

Uploaded Source

Built Distribution

nanopub-1.2.11-py3-none-any.whl (9.6 MB view details)

Uploaded Python 3

File details

Details for the file nanopub-1.2.11.tar.gz.

File metadata

  • Download URL: nanopub-1.2.11.tar.gz
  • Upload date:
  • Size: 9.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.14

File hashes

Hashes for nanopub-1.2.11.tar.gz
Algorithm Hash digest
SHA256 3a369a7d80066ca8f64872973c132eb9c98b0819244b4f1fcd7da7dab9ed4049
MD5 6ade639791a01c7c4ea7a47fa11902dc
BLAKE2b-256 c947ff5c3be7b457702464db135b6519502a3eb59e48a50f5cb749cb811b15b0

See more details on using hashes here.

File details

Details for the file nanopub-1.2.11-py3-none-any.whl.

File metadata

  • Download URL: nanopub-1.2.11-py3-none-any.whl
  • Upload date:
  • Size: 9.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.14

File hashes

Hashes for nanopub-1.2.11-py3-none-any.whl
Algorithm Hash digest
SHA256 f2628edd0b639be6e18957f0b18f4187d6502035bf4d0d5591e133b766a16498
MD5 762c3caaf95640e62d0a37ba6f3daa40
BLAKE2b-256 e63a53637f763c0b676610383e114bc5fe9a5f7678187eb1f6c65472822a50be

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