oci


Nameoci JSON
Version 2.126.3 PyPI version JSON
download
home_pagehttps://docs.oracle.com/en-us/iaas/tools/python/latest/index.html
SummaryOracle Cloud Infrastructure Python SDK
upload_time2024-05-13 15:44:24
maintainerNone
docs_urlNone
authorOracle
requires_pythonNone
licenseUniversal Permissive License 1.0 or Apache License 2.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Oracle Cloud Infrastructure Python SDK
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

=====
About
=====

This is the Python SDK for Oracle Cloud Infrastructure. Supported Python versions are mentioned `here`__.

__ https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/pythonsdk.htm#pythonsdk_topic-supported_python_versions

.. code-block:: pycon

    >>> 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": "test-user@corp.com",
      "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`__.

__ https://docs.oracle.com/en-us/iaas/tools/python/latest/index.html

============
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.

__ https://packaging.python.org/guides/installing-using-pip-and-virtualenv/

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

__ https://docs.oracle.com/en-us/iaas/tools/python/latest/installation.html

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.

__ https://github.com/oracle/oci-python-sdk/blob/master/README-development.rst

========
Examples
========

Examples can be found `here`__.

__ https://github.com/oracle/oci-python-sdk/blob/master/examples/

=============
Documentation
=============

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

API reference can be found `here`__.

__ https://docs.oracle.com/en-us/iaas/tools/python/latest/index.html
__ https://docs.oracle.com/en-us/iaas/tools/python/latest/api/landing.html

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

__ https://github.com/oracle/oci-python-sdk/releases

====
Help
====

See the “Questions or Feedback” section `here`__.

__ https://docs.oracle.com/en-us/iaas/tools/python/latest/feedback.html

=======
Changes
=======

See `CHANGELOG`__.

__ https://github.com/oracle/oci-python-sdk/blob/master/CHANGELOG.rst

============
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.

__ https://github.com/oracle/oci-python-sdk/blob/master/CONTRIBUTING.rst

============
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`__.

__ https://docs.cloud.oracle.com/Content/knownissues.htm
__ https://github.com/oracle/oci-python-sdk

=======
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.

__ https://oracle.questionpro.com/t/APeMlZka26?custom3=pypi

=======
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.

__ https://github.com/oracle/oci-python-sdk/blob/master/LICENSE.txt



            

Raw data

            {
    "_id": null,
    "home_page": "https://docs.oracle.com/en-us/iaas/tools/python/latest/index.html",
    "name": "oci",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": null,
    "author": "Oracle",
    "author_email": "joe.levy@oracle.com",
    "download_url": "https://files.pythonhosted.org/packages/77/72/8ad44f282edff8e590135d9b91fc1e93cb8f0885b610c5f0b3cf68755e2d/oci-2.126.3.tar.gz",
    "platform": null,
    "description": "Oracle Cloud Infrastructure Python SDK\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n=====\nAbout\n=====\n\nThis is the Python SDK for Oracle Cloud Infrastructure. Supported Python versions are mentioned `here`__.\n\n__ https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/pythonsdk.htm#pythonsdk_topic-supported_python_versions\n\n.. code-block:: pycon\n\n    >>> import oci\n    # Set up config\n    >>> config = oci.config.from_file(\n    ...     \"~/.oci/config\",\n    ...     \"DEFAULT\")\n    # Create a service client\n    >>> identity = oci.identity.IdentityClient(config)\n    # Get the current user\n    >>> user = identity.get_user(config[\"user\"]).data\n    >>> print(user)\n    {\n      \"compartment_id\": \"ocid1.tenancy.oc1...\",\n      \"description\": \"Test user\",\n      \"id\": \"ocid1.user.oc1...\",\n      \"inactive_status\": null,\n      \"lifecycle_state\": \"ACTIVE\",\n      \"name\": \"test-user@corp.com\",\n      \"time_created\": \"2016-08-30T23:46:44.680000+00:00\"\n    }\n\nThe project is open source and maintained by Oracle Corp. The home page for the project is `here`__.\n\n__ https://docs.oracle.com/en-us/iaas/tools/python/latest/index.html\n\n============\nInstallation\n============\n\nIt is highly recommended that a Python virtual environment be used when installing oci.\n\nPlease consult the `Installing packages using pip and virtualenv`__ guide from the Python Software Foundation for more information about virtual environments.\n\n__ https://packaging.python.org/guides/installing-using-pip-and-virtualenv/\n\nSee `the installation guide`__ for installation troubleshooting and alternative install methods.\n\n__ https://docs.oracle.com/en-us/iaas/tools/python/latest/installation.html\n\nOnce your virtual environment is active, oci can be installed using pip.\n\n::\n\n    pip install oci\n\n\n============\nDevelopment\n============\n\nSee the `development readme`__ for information on how to make changes, run tests and build the documentation and wheel for the Python SDK.\n\n__ https://github.com/oracle/oci-python-sdk/blob/master/README-development.rst\n\n========\nExamples\n========\n\nExamples can be found `here`__.\n\n__ https://github.com/oracle/oci-python-sdk/blob/master/examples/\n\n=============\nDocumentation\n=============\n\nFull documentation, including prerequisites and installation and configuration instructions, can be found `here`__.\n\nAPI reference can be found `here`__.\n\n__ https://docs.oracle.com/en-us/iaas/tools/python/latest/index.html\n__ https://docs.oracle.com/en-us/iaas/tools/python/latest/api/landing.html\n\nA downloadable version of the documentation is include with in the release zip, which can be found `here`__.\n\n__ https://github.com/oracle/oci-python-sdk/releases\n\n====\nHelp\n====\n\nSee the \u201cQuestions or Feedback\u201d section `here`__.\n\n__ https://docs.oracle.com/en-us/iaas/tools/python/latest/feedback.html\n\n=======\nChanges\n=======\n\nSee `CHANGELOG`__.\n\n__ https://github.com/oracle/oci-python-sdk/blob/master/CHANGELOG.rst\n\n============\nContributing\n============\n\noci-python-sdk is an open source project. See `CONTRIBUTING`__ for details.\n\nOracle gratefully acknowledges the contributions to oci-python-sdk that have been made by the community.\n\n__ https://github.com/oracle/oci-python-sdk/blob/master/CONTRIBUTING.rst\n\n============\nKnown Issues\n============\n\nYou can find information on any known issues with the SDK `here`__ and under the \u201cIssues\u201d tab of this\nproject's `GitHub repository`__.\n\n__ https://docs.cloud.oracle.com/Content/knownissues.htm\n__ https://github.com/oracle/oci-python-sdk\n\n=======\nSurvey\n=======\n\nAre you a Developer using the OCI SDK? If so, please fill out our survey to help us make the OCI SDK better for you.\nClick `here`__ for the survey page.\n\n__ https://oracle.questionpro.com/t/APeMlZka26?custom3=pypi\n\n=======\nLicense\n=======\n\nCopyright (c) 2016, 2021, Oracle and/or its affiliates.  All rights reserved.\nThis 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.\n\nSee `LICENSE`__ for more details.\n\n__ https://github.com/oracle/oci-python-sdk/blob/master/LICENSE.txt\n\n\n",
    "bugtrack_url": null,
    "license": "Universal Permissive License 1.0 or Apache License 2.0",
    "summary": "Oracle Cloud Infrastructure Python SDK",
    "version": "2.126.3",
    "project_urls": {
        "Homepage": "https://docs.oracle.com/en-us/iaas/tools/python/latest/index.html"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "69bcf2acb72834cce46584dc0fb4d32c4afbc6259b77eb3e45b28f18d4b57c59",
                "md5": "6e223b460873ae38d28796b1368d9b50",
                "sha256": "d84ac4bd748987f291217e86019626b1a611f3e7442c16e4f673f75ea93ac508"
            },
            "downloads": -1,
            "filename": "oci-2.126.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6e223b460873ae38d28796b1368d9b50",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 26364622,
            "upload_time": "2024-05-13T15:44:14",
            "upload_time_iso_8601": "2024-05-13T15:44:14.411881Z",
            "url": "https://files.pythonhosted.org/packages/69/bc/f2acb72834cce46584dc0fb4d32c4afbc6259b77eb3e45b28f18d4b57c59/oci-2.126.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "77728ad44f282edff8e590135d9b91fc1e93cb8f0885b610c5f0b3cf68755e2d",
                "md5": "30ab4c1f40b4f96c1b0c7a86e3d100ae",
                "sha256": "cd9ddb4fead8e628fab61a79ead1b61b40e100d7221187808b55b878d19c42f4"
            },
            "downloads": -1,
            "filename": "oci-2.126.3.tar.gz",
            "has_sig": false,
            "md5_digest": "30ab4c1f40b4f96c1b0c7a86e3d100ae",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 12818952,
            "upload_time": "2024-05-13T15:44:24",
            "upload_time_iso_8601": "2024-05-13T15:44:24.524524Z",
            "url": "https://files.pythonhosted.org/packages/77/72/8ad44f282edff8e590135d9b91fc1e93cb8f0885b610c5f0b3cf68755e2d/oci-2.126.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-13 15:44:24",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "oci"
}
        
Elapsed time: 0.25249s