Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/oracle/nosql-python-sdk

Python SDK for Oracle NoSQL Database
https://github.com/oracle/nosql-python-sdk

cloud database nosql nosql-database oracle oracle-cloud python

Last synced: 8 days ago
JSON representation

Python SDK for Oracle NoSQL Database

Awesome Lists containing this project

README 

        

Python SDK for Oracle NoSQL Database

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~



This document is for developers of the Python SDK for the Oracle NoSQL Database.

Developers are those who need to modify source and examples, build and run tests

and examples, and build documentation.



Use of "python" below may be "python3" depending on your machine

configuration. Python 3 is required.



===============

Getting Started

===============

Clone the repository and Install dependencies.



1. Make sure that Python is installed on your system, at least version 3.5.

2. Install pip if it is not installed, follow the `pip installation instructions

   `_.

3. Clone the repository and install development dependencies::



     git clone https://github.com/oracle/nosql-python-sdk.git

     cd nosql-python-sdk

     pip install -r requirements.txt



Running Tests and Examples

==========================



During development the unit tests and examples run against either a local Cloud

Simulator server, which can run on the local machine or an instance of the

on-premise Proxy that allows access to a local instance of the Oracle NoSQL

Database. See `Download the Oracle NoSQL Cloud Simulator <

https://www.oracle.com/downloads/cloud/nosql-cloud-sdk-downloads.html>`to download and start the Cloud Simulator. See `Oracle

NoSQL Downloads `_ to download the on-premise product and proxy server.



Tests and examples have settings that can be changed based on environment. Test

settings are in test/config*.py. Refer to the comments in the tests and examples

for details. The default test/config.py and test/config_cloudsim.py will use a

Cloud Simulator instance that is running on its default settings of

localhost:8080, config_cloudsim.py is a backup of config.py, when config.py is

overwritten by other config*.py, the default config.py of Cloud Simulator is

back up in config_cloudsim.py.



All tests require that your PYTHONPATH be set to the development tree:



 $ export PYTHONPATH=/nosql-python-sdk/src:\

 $PYTHONPATH



If using on-premise Oracle NoSQL database with security enabled, the certificate

path can be specified through the REQUESTS_CA_BUNDLE environment variable:



 $ export REQUESTS_CA_BUNDLE=/certificate.pem:\

 $REQUESTS_CA_BUNDLE



Or use the API :func:`borneo.NoSQLHandleConfig.set_ssl_ca_certs` to specify it.



Run Unit Tests

--------------



    1. The /test/config.py is used to run the unit test against

       Cloud Simulator, modify it to suit your environment. When config.py is

       overwritten by other config*.py, config_cloudsim.py is used to run the

       unit test against Cloud Simulator, modify it to suit your environment.

       Then copy the content of config_onprem.py to config.py.

    2. The /test/config_onprem.py is used to run the unit test

       against on-premise proxy, modify it to suit your environment. Then copy

       the content of config_onprem.py to config.py.



    Notice that the comments in these config files tells you how to modify the

    settings.



    3. With the desired server running, start testing.



       .. code-block:: pycon



          $ cd /test

          $ python -m unittest discover -p '*.py' (Run all the tests)

          $ python .py (Run individual test)



       You can also run a test case using the following command



       .. code-block:: pycon



          $ python -m unittest ..

          e.g.

          $ python -m unittest put.TestPut.testPutNoVersionWithMatchVersion



Run Examples

------------



    1. Set PYTHONPATH to point to the development tree.



       $ export PYTHONPATH=/nosql-python-sdk/src:\

       $PYTHONPATH



    2. The /examples/config.py is used to run the example against

       Cloud Simulator, modify it to suit your environment. When config.py is

       overwritten by other config*.py, config_cloudsim.py is used to run the

       unit test against Cloud Simulator, modify it to suit your environment.

       Then copy the content of config_onprem.py to config.py.

    3. The /examples/config_onprem.py is used to run the example

       against on-premise proxy, modify it to suit your environment. Then copy

       the content of config_onprem.py to config.py.

    4. The /examples/config_cloud.py is used to run the example

       against Cloud Service, modify it to suit your environment. Then copy the

       content of config_onprem.py to config.py.



    Notice that the comments in these config files tells you how to modify the

    settings.



    5. With the desired server running, run an example.



       .. code-block:: pycon



          $ cd /examples

          $ python multi_data_ops.py



Building Documentation

======================



Note: new classes and methods must be added to the appropriate files in docs/api/

or they will not be found by this build. That process is manual. The same applies

to methods that have been removed



The documentation build depends on sphinx (http://sphinx-doc.org/install.html),

sphinx-automodapi, and sphinx_rtd_theme. They should have been installed per the

instructions above.



.. code-block:: pycon



   $ cd /docs

   $ make html



Documentation is built into /docs/_build.

If public api classes are modified it may be necessary to modify, add, or remove

files in /docs/api as well as modifying relevant files in the docs

directory.