README.rst
1Oracle Cloud Infrastructure Python SDK
2~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3
4=====
5About
6=====
7
8This is the Python SDK for Oracle Cloud Infrastructure. Python 3.6, 3.7, 3.8 and 3.9 are supported.
9
10.. code-block:: pycon
11
12 >>> import oci
13 # Set up config
14 >>> config = oci.config.from_file(
15 ... "~/.oci/config",
16 ... "DEFAULT")
17 # Create a service client
18 >>> identity = oci.identity.IdentityClient(config)
19 # Get the current user
20 >>> user = identity.get_user(config["user"]).data
21 >>> print(user)
22 {
23 "compartment_id": "ocid1.tenancy.oc1...",
24 "description": "Test user",
25 "id": "ocid1.user.oc1...",
26 "inactive_status": null,
27 "lifecycle_state": "ACTIVE",
28 "name": "test-user@corp.com",
29 "time_created": "2016-08-30T23:46:44.680000+00:00"
30 }
31
32The project is open source and maintained by Oracle Corp. The home page for the project is `here`__.
33
34__ https://docs.oracle.com/en-us/iaas/tools/python/latest/index.html
35
36============
37Installation
38============
39
40It is highly recommended that a Python virtual environment be used when installing oci.
41
42Please consult the `Installing packages using pip and virtualenv`__ guide from the Python Software Foundation for more information about virtual environments.
43
44__ https://packaging.python.org/guides/installing-using-pip-and-virtualenv/
45
46See `the installation guide`__ for installation troubleshooting and alternative install methods.
47
48__ https://docs.oracle.com/en-us/iaas/tools/python/latest/installation.html
49
50Once your virtual environment is active, oci can be installed using pip.
51
52::
53
54 pip install oci
55
56
57============
58Development
59============
60
61See the `development readme`__ for information on how to make changes, run tests and build the documentation and wheel for the Python SDK.
62
63__ https://github.com/oracle/oci-python-sdk/blob/master/README-development.rst
64
65========
66Examples
67========
68
69Examples can be found `here`__.
70
71__ https://github.com/oracle/oci-python-sdk/blob/master/examples/
72
73=============
74Documentation
75=============
76
77Full documentation, including prerequisites and installation and configuration instructions, can be found `here`__.
78
79API reference can be found `here`__.
80
81__ https://docs.oracle.com/en-us/iaas/tools/python/latest/index.html
82__ https://docs.oracle.com/en-us/iaas/tools/python/latest/api/landing.html
83
84A downloadable version of the documentation is include with in the release zip, which can be found `here`__.
85
86__ https://github.com/oracle/oci-python-sdk/releases
87
88====
89Help
90====
91
92See the “Questions or Feedback” section `here`__.
93
94__ https://docs.oracle.com/en-us/iaas/tools/python/latest/feedback.html
95
96=======
97Changes
98=======
99
100See `CHANGELOG`__.
101
102__ https://github.com/oracle/oci-python-sdk/blob/master/CHANGELOG.rst
103
104============
105Contributing
106============
107
108oci-python-sdk is an open source project. See `CONTRIBUTING`__ for details.
109
110Oracle gratefully acknowledges the contributions to oci-python-sdk that have been made by the community.
111
112__ https://github.com/oracle/oci-python-sdk/blob/master/CONTRIBUTING.rst
113
114============
115Known Issues
116============
117
118You can find information on any known issues with the SDK `here`__ and under the “Issues” tab of this
119project's `GitHub repository`__.
120
121__ https://docs.cloud.oracle.com/Content/knownissues.htm
122__ https://github.com/oracle/oci-python-sdk
123
124=======
125Survey
126=======
127
128Are you a Developer using the OCI SDK? If so, please fill out our survey to help us make the OCI SDK better for you.
129Click `here`__ for the survey page.
130
131__ https://oracle.questionpro.com/t/APeMlZka26?custom3=pypi
132
133=======
134License
135=======
136
137Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved.
138This 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.
139
140See `LICENSE`__ for more details.
141
142__ https://github.com/oracle/oci-python-sdk/blob/master/LICENSE.txt
143