Merge branch 'master' into ec2-credentials

.github/workflows/integration_block_storage.yml

@@ -1,4 +1,4 @@
-name: Run Block Storage Integration Tests
+name: Block Storage Integration Tests
 
 on:
   workflow_dispatch:

.github/workflows/integration_compute.yml

@@ -1,4 +1,4 @@
-name: Run Compute Integration Tests
+name: Compute Integration Tests
 on:
   workflow_dispatch:
   pull_request:

.github/workflows/integration_identity.yml

@@ -1,4 +1,4 @@
-name: Run Identity Integration Tests
+name: Identity Integration Tests
 on:
   workflow_dispatch:
   pull_request:

.github/workflows/integration_images.yml

@@ -1,4 +1,4 @@
-name: Run Images Integration Tests
+name: Images Integration Tests
 on:
   workflow_dispatch:
   pull_request:

.github/workflows/integration_networking.yml

@@ -1,4 +1,4 @@
-name: Run Networking Integration Tests
+name: Networking Integration Tests
 on:
   workflow_dispatch:
   pull_request:

.github/workflows/integration_object_storage.yml

@@ -1,4 +1,4 @@
-name: Run Object Storage Integration Tests
+name: Object Storage Integration Tests
 on:
   workflow_dispatch:
   pull_request:

.github/workflows/unit_tests.yml

@@ -1,4 +1,4 @@
-name: Run Unit Tests
+name: Unit Tests
 on:
   workflow_dispatch:
   pull_request:

.readthedocs.yaml

@@ -0,0 +1,22 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+# Build documentation in the "doc/" directory with Sphinx
+sphinx:
+  configuration: doc/conf.py
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - requirements: doc/requirements.txt

README.md

@@ -1,8 +1,15 @@
 # PHP OpenStack SDK
 
-[![Build Status](https://travis-ci.org/php-opencloud/openstack.svg?branch=master)](https://travis-ci.org/php-opencloud/openstack)
-[![Coverage Status](https://coveralls.io/repos/github/php-opencloud/openstack/badge.svg?branch=master)](https://coveralls.io/github/php-opencloud/openstack?branch=master)
-[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/php-opencloud/openstack/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/php-opencloud/openstack/?branch=master)
+
+![Unit tests](https://github.com/php-opencloud/openstack/actions/workflows/unit_tests.yml/badge.svg)
+[![Documentation Status](https://readthedocs.org/projects/php-openstack-sdk/badge/?version=latest)](https://php-openstack-sdk.readthedocs.io/en/latest/?badge=latest)
+
+[![Block Storage Integration Tests](https://github.com/php-opencloud/openstack/actions/workflows/integration_block_storage.yml/badge.svg)](https://github.com/php-opencloud/openstack/actions/workflows/integration_block_storage.yml)
+[![Compute Integration Tests](https://github.com/php-opencloud/openstack/actions/workflows/integration_compute.yml/badge.svg)](https://github.com/php-opencloud/openstack/actions/workflows/integration_compute.yml)
+[![Identity Integration Tests](https://github.com/php-opencloud/openstack/actions/workflows/integration_identity.yml/badge.svg)](https://github.com/php-opencloud/openstack/actions/workflows/integration_identity.yml)
+[![Images Integration Tests](https://github.com/php-opencloud/openstack/actions/workflows/integration_images.yml/badge.svg)](https://github.com/php-opencloud/openstack/actions/workflows/integration_images.yml)
+[![Networking Integration Tests](https://github.com/php-opencloud/openstack/actions/workflows/integration_networking.yml/badge.svg)](https://github.com/php-opencloud/openstack/actions/workflows/integration_networking.yml)
+[![Object Storage Integration Tests](https://github.com/php-opencloud/openstack/actions/workflows/integration_object_storage.yml/badge.svg)](https://github.com/php-opencloud/openstack/actions/workflows/integration_object_storage.yml)
 
 `php-opencloud/openstack` is an SDK which allows PHP developers to easily connect to OpenStack APIs in a simple and 
 idiomatic way. This binding is specifically designed for OpenStack APIs, but other provider SDKs are available. Multiple 
@@ -15,36 +22,23 @@ OpenStack services, and versions of services, are supported.
 * [Contributing guide](/CONTRIBUTING.md)
 * [Code of Conduct](/CODE_OF_CONDUCT.md)
 
-
-## We need your help :smiley: 
-
-We invest a large amount of work to ensure this SDK works with many OpenStack distributions via running end-to-end 
-integration tests with a real cluster.
-
-If you or your organization are in a position that can help us access popular distributions as listed below, do reach 
-out by open an issue in github.
-
-| Distribution                       |                         |
-|------------------------------------|-------------------------|
-|OpenStack RDO<br>MicroStack Openstack | Sponsored by [![Ai.net](https://i.imgur.com/wsFRFuX.png)](https://www.ai.net/) |
-|Red Hat OpenStack                   | Need sponsor!           |
-|OVH OpenStack                       | Need sponsor!           |
-|SUSE OpenStack                      | Need sponsor!           |
-|RackSpace OpenStack                 | Need sponsor!           |
-
 ## Join the community
 
-- Meet us on Slack: https://phpopencloud.slack.com ([Get your invitation](https://launchpass.com/phpopencloud))
 - Report an issue: https://github.com/php-opencloud/openstack/issues
 
-## Version Guidance
+## Versioning
+
+Openstack SDK follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+Updating between minor versions will not require changes to PHP code or configuration
+and cause no breaking behavioural changes for consumers.
 
-| Version   | Status                      | PHP Version      | Support until           |
-| --------- | --------------------------- | ---------------- | ----------------------- |
-| `^3.2`    | Latest                      | `>=7.2.5, >=8.0`  | Current                 |
-| `^3.1`    | Latest                      | `>=7.2.5`        | Current                 |
-| `^3.0`    | Bug fixed only              | `>=7.0`          | Oct 2020                |
-| `^2.0`    | End of life                 | `>=7.0,<7.2`     | March 2018              |
+| Version   | Status      | PHP Version      | Support until           |
+| --------- |-------------| ---------------- | ----------------------- |
+| `^3.2`    | Latest      | `>=7.2.5, >=8.0` | Current                 |
+| `^3.1`    | Latest      | `>=7.2.5`        | Current                 |
+| `^3.0`    | End of life | `>=7.0`          | Oct 2020                |
+| `^2.0`    | End of life | `>=7.0,<7.2`     | March 2018              |
 
 
 ## Upgrade from 2.x to 3.x
@@ -57,7 +51,7 @@ This change was introduced in [#184](https://github.com/php-opencloud/openstack/
 
 ## Requirements
 
-* PHP 7.0
+* PHP >= 7.2.5
 * `ext-curl`
 
 ## How to install
@@ -71,6 +65,5 @@ composer require php-opencloud/openstack
 Engaging the community and lowering barriers for contributors is something we care a lot about. For this reason, we've 
 taken the time to write a [contributing guide](CONTRIBUTING.md) for folks interested in getting involved in our project. 
 If you're not sure how you can get involved, feel free to 
-[submit an issue](https://github.com/php-opencloud/openstack/issues/new) or 
-[contact us](https://developer.rackspace.com/support/). You don't need to be a PHP expert - all members of the 
+[submit an issue](https://github.com/php-opencloud/openstack/issues/new). You don't need to be a PHP expert - all members of the 
 community are welcome!

doc/.gitignore

@@ -1,2 +1,3 @@
+.idea/
 _build/
 api-docs/build

doc/_exts/samples.py

@@ -1,7 +1,6 @@
-from sphinx.directives import LiteralInclude
 from docutils import nodes
 from sphinx.addnodes import download_reference
-from sphinx.writers.html import HTMLTranslator
+from sphinx.directives.code import LiteralInclude
 import re
 
 class Sample(LiteralInclude):
@@ -10,7 +9,7 @@ def run(self):
     self.arguments[0] = "/../samples/" + self.arguments[0]
     self.options['language'] = 'php'
 
-    pattern = "[\s+]?(\<\?php.*?]\);)"
+    pattern = r"[\s+]?(\<\?php.*?]\);)"
 
     code_block = super(Sample, self).run()[0]
     string = str(code_block[0])
@@ -29,13 +28,6 @@ def run(self):
         nodes.literal_block(auth_str, auth_str, language="php"), 
         nodes.literal_block(main_str, main_str, language="php")]
 
-def visit_download_reference(self, node):
-  self.context.append('<a href="javascript:void(0);" class="toggle btn">Show auth code</a>')
-
-def depart_download_reference(self, node):
-  self.body.append(self.context.pop())
-
 def setup(app):
-  app.add_node(download_reference, html=(visit_download_reference, depart_download_reference))
   app.add_directive('sample', Sample)
   return {'version': '0.1'}