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
Dependabot

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. It also contains a server validator tool, which may be called from the shell or used as a GitHub Action from optimade-validator-action.

Disclaimer: While the package supports elasticsearch-dsl v6 & v7 and django v2 & v3, all tests are performed with the latest supported version. If you experience any issues with the older versions, you are most welcome to contribute to the repository (see below under Contributing).

Status

Both the OPTIMADE specification and this repository are under development.

The latest stable version can be obtained from PyPI pip install optimade or by cloning the master branch of this repository git clone git@github.com:Materials-Consortia/optimade-python-tools.

Installation

Installation instructions, for both the index meta-database, and for the main API can be found in INSTALL.md.

Contributing

Contribution guidelines and tips can be found in CONTRIBUTING.md.

Links

Project details


Release history Release notifications | RSS feed

This version

0.9.8

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.9.8.tar.gz (81.0 kB view hashes)

Uploaded Source

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