Skip to main content

Tools for implementing and consuming OPTIMADE APIs.

Project description

OPTIMADE Python tools

Latest release Build status Activity
PyPI Version
PyPI - Python Version
OPTIMADE
Build Status
codecov
Heroku App Status
Commit Activity
Last Commit
Contributors

The aim of OPTIMADE is to develop a common API, compliant with the JSON API 1.0 specification. This is to enable interoperability among databases that contain calculated properties of existing and hypothetical materials.

This repository contains a library of tools for implementing and consuming OPTIMADE APIs using Python. Server implementations can make use of the supported MongoDB (v4) and Elasticsearch (v6) database backends, or plug in a custom backend implementation. The package also contains a server validator tool, which may be called from the shell (optimade-validator) or used as a GitHub Action from optimade-validator-action.

Status

Whilst v1.0 of the OPTIMADE specification has been released, this repository is under development. Outstanding features required for compliance with OPTIMADE v1.0 can be tracked with the OPTIMADE v1.0 label on GitHub, which can be further filtered by backend. The release history and changelog can be found in the changelog.

Documentation

This document, guides, and the full module API documentation can be found online at https://optimade.org/optimade-python-tools.

Installation

Detailed instructions for installing and running the index meta-database and the main API can be found in the installation documentation.

The latest stable version of this package can be obtained from PyPI pip install optimade. The latest development version of this package can be installed from the master branch of this repository git clone https://github.com/Materials-Consortia/optimade-python-tools.

Supported OPTIMADE versions

Each release of the optimade package from this repository only targets one version of the OPTIMADE specification, summarised in the table below.

OPTIMADE API version optimade version
v1.0.0 v0.12.9
v1.1.0 v0.16.0

Contributing

Contribution tips and guidelines can be found in the contributing guidelines.

Links

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

optimade-0.16.2.tar.gz (124.7 kB view details)

Uploaded Source

File details

Details for the file optimade-0.16.2.tar.gz.

File metadata

  • Download URL: optimade-0.16.2.tar.gz
  • Upload date:
  • Size: 124.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.6

File hashes

Hashes for optimade-0.16.2.tar.gz
Algorithm Hash digest
SHA256 6500243a11ad21e06b81a093e552e19f9282f5a67e32562ad7b65a7b6e3aee66
MD5 cd57e633d65c712d492f72112061bcbb
BLAKE2b-256 901a45c263c37fbe0d8ea93510ea089dcbf84408485208fd4e446af258c5dd84

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