Skip to main content

Run Wikidata Sparql queries directly on your notebook

Project description

PyPI - License PyPI PyPI - Status Binder

wdsparqlmagic

IPython magic to run Wikidata's Sparql queries on the notebooks

Sample Notebook

You can run the sample notebook on binder

Features

Magics

  • %%wdsparql: Runs the cell as a sparql query on your notebook
  • %wdseturl <url>: Sets the url to run the queries against
  • %wdreseturl: Resets the url

Other features

  • After running a wdsparql query, a pandas dataframe will be available as _dfwd. You can run all common pandas operations against it.

Developing

Publishing

Just add a new tag or release with git tag vX.Y.Z -m "<Comment>"; git push --tags

TODO:

  • What happens if an error occurs?
    • Raising custom exception
  • Expose the last query result to the namespace as a pandas dataframe
  • Create setup.py
  • Upload to pypi
  • Make sample notebook (use wikipedia's queries)
  • Write the README.md
    • Button to "run with binder"
    • Explain all the magics:
      • wdsparql
      • wdseturl
      • wdreseturl
  • Testing
    • Unit testing for the functions
    • Visual testing for the sample notebook
  • Make test, build and upload automatically using github actions
    • Check linting tools
    • Use matrix to check with multiple python versions
  • For displaying, stop using dataframes and use a custom class
    • Make links clickable
    • Make items appear as <a href="<link">Q1984194810</a>
    • Display images
    • Display map
  • Adding more queries than the simple ones to the notebook

Optional:

  • Making a new kernel instead of an extension (select cell language: sparql)

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

wdsparql-0.0.3.tar.gz (12.1 kB view details)

Uploaded Source

Built Distribution

wdsparql-0.0.3-py3-none-any.whl (5.0 kB view details)

Uploaded Python 3

File details

Details for the file wdsparql-0.0.3.tar.gz.

File metadata

  • Download URL: wdsparql-0.0.3.tar.gz
  • Upload date:
  • Size: 12.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.12

File hashes

Hashes for wdsparql-0.0.3.tar.gz
Algorithm Hash digest
SHA256 dbb10f5a0caba153633efd53a73d065a32d68f667a2f3b517ff5e5495846201d
MD5 ab4bd4081d43123e92733d43b5221d45
BLAKE2b-256 01819d44fc2793c2f596b0930eea3df83c3274c4dc5c34bbf78bc65d44d3c0bc

See more details on using hashes here.

File details

Details for the file wdsparql-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: wdsparql-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 5.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.12

File hashes

Hashes for wdsparql-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 55e2f427461db87e87dd739c978b009e288f75c4ca554f5cd80a035f31380518
MD5 787e3ecc7c9d92350e9f6b79dbc6fcb8
BLAKE2b-256 ad037682ccf6cab87ef8ea39f89abf39855e39db86ab08bf2bf8aa73f3b53bff

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