Skip to content

Latest commit

 

History

History
142 lines (94 loc) · 3.97 KB

README.rst

File metadata and controls

142 lines (94 loc) · 3.97 KB
Raw

Oracle Cloud Infrastructure Python SDK

About

This is the Python SDK for Oracle Cloud Infrastructure. Python 3.6, 3.7, 3.8 and 3.9 are supported.

>>> import oci
# Set up config
>>> config = oci.config.from_file(
...     "~/.oci/config",
...     "DEFAULT")
# Create a service client
>>> identity = oci.identity.IdentityClient(config)
# Get the current user
>>> user = identity.get_user(config["user"]).data
>>> print(user)
{
  "compartment_id": "ocid1.tenancy.oc1...",
  "description": "Test user",
  "id": "ocid1.user.oc1...",
  "inactive_status": null,
  "lifecycle_state": "ACTIVE",
  "name": "[email protected]",
  "time_created": "2016-08-30T23:46:44.680000+00:00"
}

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

Installation

It is highly recommended that a Python virtual environment be used when installing oci.

Please consult the Installing packages using pip and virtualenv guide from the Python Software Foundation for more information about virtual environments.

See the installation guide for installation troubleshooting and alternative install methods.

Once your virtual environment is active, oci can be installed using pip.

pip install oci

Development

See the development readme for information on how to make changes, run tests and build the documentation and wheel for the Python SDK.

Examples

Examples can be found here.

Documentation

Full documentation, including prerequisites and installation and configuration instructions, can be found here.

API reference can be found here.

A downloadable version of the documentation is include with in the release zip, which can be found here.

Help

See the “Questions or Feedback” section here.

Changes

See CHANGELOG.

Contributing

oci-python-sdk is an open source project. See CONTRIBUTING for details.

Oracle gratefully acknowledges the contributions to oci-python-sdk that have been made by the community.

Known Issues

You can find information on any known issues with the SDK here and under the “Issues” tab of this project's GitHub repository.

Survey

Are you a Developer using the OCI SDK? If so, please fill out our survey to help us make the OCI SDK better for you. Click here for the survey page.

License

Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.

See LICENSE for more details.