{"id":18554290,"url":"https://github.com/oracle/nosql-python-sdk","last_synced_at":"2025-04-06T19:13:40.771Z","repository":{"id":37577962,"uuid":"172936268","full_name":"oracle/nosql-python-sdk","owner":"oracle","description":"Python SDK for Oracle NoSQL Database","archived":false,"fork":false,"pushed_at":"2025-03-24T17:09:22.000Z","size":947,"stargazers_count":18,"open_issues_count":1,"forks_count":15,"subscribers_count":10,"default_branch":"main","last_synced_at":"2025-03-30T17:11:15.218Z","etag":null,"topics":["cloud","database","nosql","nosql-database","oracle","oracle-cloud","python"],"latest_commit_sha":null,"homepage":"https://www.oracle.com/database/nosql/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"upl-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oracle.png","metadata":{"files":{"readme":"README-DEV.rst","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-02-27T15:03:01.000Z","updated_at":"2025-03-24T17:09:23.000Z","dependencies_parsed_at":"2023-11-13T20:24:29.696Z","dependency_job_id":"9bb795ea-83b4-4056-aa65-8cdb0bb22421","html_url":"https://github.com/oracle/nosql-python-sdk","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle%2Fnosql-python-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle%2Fnosql-python-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle%2Fnosql-python-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle%2Fnosql-python-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oracle","download_url":"https://codeload.github.com/oracle/nosql-python-sdk/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247535520,"owners_count":20954576,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cloud","database","nosql","nosql-database","oracle","oracle-cloud","python"],"created_at":"2024-11-06T21:21:05.471Z","updated_at":"2025-04-06T19:13:40.753Z","avatar_url":"https://github.com/oracle.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\nPython SDK for Oracle NoSQL Database\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nThis document is for developers of the Python SDK for the Oracle NoSQL Database.\nDevelopers are those who need to modify source and examples, build and run tests\nand examples, and build documentation.\n\nUse of \"python\" below may be \"python3\" depending on your machine\nconfiguration. Python 3 is required.\n\n===============\nGetting Started\n===============\nClone the repository and Install dependencies.\n\n1. Make sure that Python is installed on your system, at least version 3.5.\n2. Install pip if it is not installed, follow the `pip installation instructions\n   \u003chttps://pip.pypa.io/en/stable/installing\u003e`_.\n3. Clone the repository and install development dependencies::\n\n     git clone https://github.com/oracle/nosql-python-sdk.git\n     cd nosql-python-sdk\n     pip install -r requirements.txt\n\nRunning Tests and Examples\n==========================\n\nDuring development the unit tests and examples run against either a local Cloud\nSimulator server, which can run on the local machine or an instance of the\non-premise Proxy that allows access to a local instance of the Oracle NoSQL\nDatabase. See `Download the Oracle NoSQL Cloud Simulator \u003c\nhttps://www.oracle.com/downloads/cloud/nosql-cloud-sdk-downloads.html\u003e`to download and start the Cloud Simulator. See `Oracle\nNoSQL Downloads \u003chttps://www.oracle.com/database/technologies/nosql-database-\nserver-downloads.html\u003e`_ to download the on-premise product and proxy server.\n\nTests and examples have settings that can be changed based on environment. Test\nsettings are in test/config*.py. Refer to the comments in the tests and examples\nfor details. The default test/config.py and test/config_cloudsim.py will use a\nCloud Simulator instance that is running on its default settings of\nlocalhost:8080, config_cloudsim.py is a backup of config.py, when config.py is\noverwritten by other config*.py, the default config.py of Cloud Simulator is\nback up in config_cloudsim.py.\n\nAll tests require that your PYTHONPATH be set to the development tree:\n\n $ export PYTHONPATH=\u003cpath-to-nosql-python-sdk\u003e/nosql-python-sdk/src:\\\n $PYTHONPATH\n\nIf using on-premise Oracle NoSQL database with security enabled, the certificate\npath can be specified through the REQUESTS_CA_BUNDLE environment variable:\n\n $ export REQUESTS_CA_BUNDLE=\u003cpath-to-certificate\u003e/certificate.pem:\\\n $REQUESTS_CA_BUNDLE\n\nOr use the API :func:`borneo.NoSQLHandleConfig.set_ssl_ca_certs` to specify it.\n\nRun Unit Tests\n--------------\n\n    1. The \u003cpath-to-repo\u003e/test/config.py is used to run the unit test against\n       Cloud Simulator, modify it to suit your environment. When config.py is\n       overwritten by other config*.py, config_cloudsim.py is used to run the\n       unit test against Cloud Simulator, modify it to suit your environment.\n       Then copy the content of config_onprem.py to config.py.\n    2. The \u003cpath-to-repo\u003e/test/config_onprem.py is used to run the unit test\n       against on-premise proxy, modify it to suit your environment. Then copy\n       the content of config_onprem.py to config.py.\n\n    Notice that the comments in these config files tells you how to modify the\n    settings.\n\n    3. With the desired server running, start testing.\n\n       .. code-block:: pycon\n\n          $ cd \u003cpath-to-repo\u003e/test\n          $ python -m unittest discover -p '*.py' (Run all the tests)\n          $ python \u003ctestcase\u003e.py (Run individual test)\n\n       You can also run a test case using the following command\n\n       .. code-block:: pycon\n\n          $ python -m unittest \u003ctestfile\u003e.\u003ctestclass\u003e.\u003ctestname\u003e\n          e.g.\n          $ python -m unittest put.TestPut.testPutNoVersionWithMatchVersion\n\nRun Examples\n------------\n\n    1. Set PYTHONPATH to point to the development tree.\n\n       $ export PYTHONPATH=\u003cpath-to-nosql-python-sdk\u003e/nosql-python-sdk/src:\\\n       $PYTHONPATH\n\n    2. The \u003cpath-to-repo\u003e/examples/config.py is used to run the example against\n       Cloud Simulator, modify it to suit your environment. When config.py is\n       overwritten by other config*.py, config_cloudsim.py is used to run the\n       unit test against Cloud Simulator, modify it to suit your environment.\n       Then copy the content of config_onprem.py to config.py.\n    3. The \u003cpath-to-repo\u003e/examples/config_onprem.py is used to run the example\n       against on-premise proxy, modify it to suit your environment. Then copy\n       the content of config_onprem.py to config.py.\n    4. The \u003cpath-to-repo\u003e/examples/config_cloud.py is used to run the example\n       against Cloud Service, modify it to suit your environment. Then copy the\n       content of config_onprem.py to config.py.\n\n    Notice that the comments in these config files tells you how to modify the\n    settings.\n\n    5. With the desired server running, run an example.\n\n       .. code-block:: pycon\n\n          $ cd \u003cpath-to-repo\u003e/examples\n          $ python multi_data_ops.py\n\nBuilding Documentation\n======================\n\nNote: new classes and methods must be added to the appropriate files in docs/api/\nor they will not be found by this build. That process is manual. The same applies\nto methods that have been removed\n\nThe documentation build depends on sphinx (http://sphinx-doc.org/install.html),\nsphinx-automodapi, and sphinx_rtd_theme. They should have been installed per the\ninstructions above.\n\n.. code-block:: pycon\n\n   $ cd \u003cpath-to-repo\u003e/docs\n   $ make html\n\nDocumentation is built into \u003cpath-to-repo\u003e/docs/_build.\nIf public api classes are modified it may be necessary to modify, add, or remove\nfiles in \u003cpath-to-repo\u003e/docs/api as well as modifying relevant files in the docs\ndirectory.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foracle%2Fnosql-python-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foracle%2Fnosql-python-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foracle%2Fnosql-python-sdk/lists"}