borneo 5.1.0

Oracle NoSQL Database Python SDK

About

Note

This release of the Python SDK for Oracle NoSQL Database supports only the on-premise release, starting with 19.3. It will not work with the Oracle NoSQL Database Cloud Service. To work with the Cloud Service use the 5.0.1 release or the next release of this SDK that does not have this notice.

This is the Python SDK for Oracle NoSQL Database. Python 2.7+ and 3.5+ are supported. The SDK provides interfaces, documentation, and examples to help develop Python applications that connect to the Oracle NoSQL Database Cloud Service, Oracle NoSQL Database and to the Oracle NoSQL Cloud Simulator (which runs on a local machine).

In order to run the Oracle NoSQL Cloud Simulator, a separate download is necessary from the Oracle NoSQL OTN download page. Throughout the documentation the Oracle NoSQL Database Cloud Service and Cloud Simulator are referred to as the “cloud service” while the Oracle NoSQL Database is referred to as “on-premise.” In the API reference classes and interfaces are noted if they are only relevant to a specific environment.

The on-premise configuration requires a running instance of the Oracle NoSQL database. In addition a running proxy service is required. See Oracle NoSQL Database Downloads for downloads, and see Information about the proxy for proxy configuration information.

This project is open source and maintained by Oracle Corp. The home page for the project is here

Installation

The SDK can be installed using pip:

pip install borneo

See the installation guide for additional requirements and and alternative install methods.

Examples

Examples can be found on GitHub.

Examples include simple, standalone programs. They include comments bout how they can be configured and run in the different supported environments.

Documentation

The documentation has information on using the SDK as well as an API reference describing the classes.

Development

The development readme has information about running tests and examples, building the documentation, and other development activities.

Changes

See the Changelog.

Contributing

The nosql-python-sdk is an open source project. See Contributing for information on how to contribute to the project.

License

Copyright (C) 2018, 2019 Oracle and/or its affiliates. All rights reserved.

This SDK is licensed under the Universal Permissive License 1.0. See LICENSE for details