Merge pull request #27 from oracle/release_2017-09-11

Releasing version 1.3.7

Author: nathan-vu

CHANGELOG.rst

@@ -4,6 +4,26 @@ All notable changes to this project will be documented in this file.
 
 The format is based on `Keep a Changelog <http://keepachangelog.com/>`_.
 
+====================
+1.3.7 - 2017-09-11
+====================
+
+Deprecated
+----------
+* The default configuration file location has been changed from ~/.oraclebmc/config to ~/.oci/config. The old location still works if the file at the new location does not exist.
+
+Added
+-----
+* Support for the Database service
+* Support for instance console connections
+* Support for the Load Balancer Health Status API
+* Support for Compartment renaming
+* Support for managing customer secret keys
+
+Changed
+-------
+* The default configuration file location is now ~/.oci/config
+
 ====================
 1.3.6 - 2017-08-10
 ====================
@@ -57,7 +77,7 @@ Added
  Added
 -------
 
-* Support for VCN private subnets using the prohibit_public_ip_on_vnic parameter on oraclebmc.core.VirtualNetworkClient.create_subnet.
+* Support for VCN private subnets using the prohibit_public_ip_on_vnic parameter on oci.core.VirtualNetworkClient.create_subnet.
 * Support for FastConnect
 * Support for list_regions and region subscription operations
 * First class support for new IAD region

CONTRIBUTING.rst

@@ -1,4 +1,4 @@
-Contributing to the Oracle Bare Metal Cloud Services Python SDK
+Contributing to the Oracle Cloud Infrastructure Python SDK
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 *Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.*

README.rst

@@ -1,21 +1,21 @@
-Oracle Bare Metal Cloud Services Python SDK
+Oracle Cloud Infrastructure Python SDK
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 =====
 About
 =====
 
-This is the Python SDK for Oracle Bare Metal Cloud Services. Python 2.7+ and 3.5+ are supported.
+This is the Python SDK for Oracle Cloud Infrastructure. Python 2.7+ and 3.5+ are supported.
 
 .. code-block:: pycon
 
-    >>> import oraclebmc
+    >>> import oci
     # Set up config
-    >>> config = oraclebmc.config.from_file(
-    ...     "~/.oraclebmc/config",
+    >>> config = oci.config.from_file(
+    ...     "~/.oci/config",
     ...     "DEFAULT")
     # Create a service client
-    >>> identity = oraclebmc.identity.IdentityClient(config)
+    >>> identity = oci.identity.IdentityClient(config)
     # Get the current user
     >>> user = identity.get_user(config["user"]).data
     >>> print(user)
@@ -31,28 +31,88 @@ This is the Python SDK for Oracle Bare Metal Cloud Services. Python 2.7+ and 3.5
 
 The project is open source and maintained by Oracle Corp. The home page for the project is `here`__.
 
-__ https://oracle-bare-metal-cloud-services-python-sdk.readthedocs.io/en/latest/index.html
+__ https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/index.html
 
 ============
 Installation
 ============
 
 ::
 
-    pip install oraclebmc
+    pip install oci
 
 
 See `the installation guide`__ for installation troubleshooting and alternative install methods.
 
-__ https://oracle-bare-metal-cloud-services-python-sdk.readthedocs.io/en/latest/installation.html
+__ https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/installation.html
+
+============
+Development
+============
+
+Getting Started
+===============
+Assuming that you have Python and `virtualenv` installed, set up your environment and install the required dependencies like this:
+
+.. code-block:: sh
+
+    git clone https://github.com/oracle/oci-python-sdk.git
+    cd oci-python-sdk
+    virtualenv oci-python-sdk-env
+    . oci-python-sdk-env/bin/activate
+    pip install -r requirements.txt
+    pip install -e .
+
+You should also set up your configuration files as described `here`__
+
+__ https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/sdkconfig.htm 
+
+Running Tests
+=============
+The SDK uses `pytest` as its test framework. You can run tests against Python 2.7 Python 3.5 using the `tox` command. Note that this requires that you have those versions of Python installed, 
+otherwise you must pass `-e` or run tests directly:
+
+.. code-block:: sh
+
+    # This will run tests against all configured Pythons in tox.ini (currently 2.7 and 3.5). You need to have those versions installed
+    tox
+
+    # This will run tests against a specific Python versions
+    tox -e py27
+
+If you wish to run an individual test then you can run:
+
+.. code-block:: sh
+
+    py.test -s tests/integ/test_launch_instance_tutorial.py
+
+Generating Documentation
+========================
+Sphinx is used for documentation. You can generate HTML locally with the following:
+
+.. code-block:: sh
+
+    pip install -r requirements.txt
+    cd docs
+    make html
+
+Generating the wheel
+====================
+The SDK is packaged as a wheel. In order to generate the wheel you can run:
+
+.. code-block:: sh
+
+    python setup.py sdist bdist_wheel
+
+This wheel can then be installed via `pip`.
 
 ========
 Examples
 ========
 
 Examples can be found `here`__.
 
-__ https://github.com/oracle/bmcs-python-sdk/blob/master/examples/
+__ https://github.com/oracle/oci-python-sdk/blob/master/examples/
 
 =============
 Documentation
@@ -62,34 +122,34 @@ Full documentation, including prerequisites and installation and configuration i
 
 API reference can be found `here`__.
 
-__ https://oracle-bare-metal-cloud-services-python-sdk.readthedocs.io/en/latest/index.html
-__ https://oracle-bare-metal-cloud-services-python-sdk.readthedocs.io/en/latest/api/index.html
+__ https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/index.html
+__ https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/api/index.html
 
 ====
 Help
 ====
 
 See the “Questions or Feedback” section `here`__.
 
-__ https://oracle-bare-metal-cloud-services-python-sdk.readthedocs.io/en/latest/feedback.html
+__ https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/feedback.html
 
 =======
 Changes
 =======
 
 See `CHANGELOG`__.
 
-__ https://github.com/oracle/bmcs-python-sdk/blob/master/CHANGELOG.rst
+__ https://github.com/oracle/oci-python-sdk/blob/master/CHANGELOG.rst
 
 ============
 Contributing
 ============
 
-bmcs-python-sdk is an open source project. See `CONTRIBUTING`__ for details.
+oci-python-sdk is an open source project. See `CONTRIBUTING`__ for details.
 
-Oracle gratefully acknowledges the contributions to bmcs-python-sdk that have been made by the community.
+Oracle gratefully acknowledges the contributions to oci-python-sdk that have been made by the community.
 
-__ https://github.com/oracle/bmcs-python-sdk/blob/master/CONTRIBUTING.rst
+__ https://github.com/oracle/oci-python-sdk/blob/master/CONTRIBUTING.rst
 
 ============
 Known Issues
@@ -99,7 +159,7 @@ You can find information on any known issues with the SDK `here`__ and under the
 project's `GitHub repository`__.
 
 __ https://docs.us-phoenix-1.oraclecloud.com/Content/knownissues.htm
-__ https://github.com/oracle/bmcs-python-sdk
+__ https://github.com/oracle/oci-python-sdk
 
 =======
 License
@@ -111,4 +171,4 @@ This SDK and sample is dual licensed under the Universal Permissive License 1.0
 
 See `LICENSE`__ for more details.
 
-__ https://github.com/oracle/bmcs-python-sdk/blob/master/LICENSE.txt
+__ https://github.com/oracle/oci-python-sdk/blob/master/LICENSE.txt

docs/Makefile

@@ -92,9 +92,9 @@ qthelp:
 	@echo
 	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
 	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
-	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/oraclebmc.qhcp"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/oci.qhcp"
 	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/oraclebmc.qhc"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/oci.qhc"
 
 .PHONY: applehelp
 applehelp:
@@ -111,8 +111,8 @@ devhelp:
 	@echo
 	@echo "Build finished."
 	@echo "To view the help file:"
-	@echo "# mkdir -p $$HOME/.local/share/devhelp/oraclebmc"
-	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/oraclebmc"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/oci"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/oci"
 	@echo "# devhelp"
 
 .PHONY: epub