Merge pull request #34 from platformsh/gh-prefix

GH Actions + rename var_prefix.

Author: Crell

.circleci/config.yml

@@ -0,0 +1,21 @@
+---
+name: Publish (pypi)
+on:
+    push: ~
+
+jobs:
+    deploy:
+        name: [publish] pypi
+        runs-on: ubuntu-latest
+        steps:
+        - uses: actions/checkout@v2
+        - name: Get tag
+          id: vars
+          run: echo ::set-output name=tag::${GITHUB_REF#refs/*/}
+        - if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
+          env:
+            GHACTION_TAG: ${{ steps.vars.outputs.tag }}
+          uses: pypa/gh-action-pypi-publish@v1.4.1
+          with:
+                user: __token__
+                password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/pypi-publish.yaml

@@ -0,0 +1,21 @@
+---
+name: Quality Assurance
+on:
+    push: ~
+    pull_request: ~
+
+jobs:
+    build:
+        name: '[Build/test] Python ${{ matrix.python }}'
+        runs-on: ubuntu-latest
+        strategy:
+            matrix:
+                python: [ '3.5', '3.6', '3.7', '3.8' ]
+        steps:
+            - uses: actions/checkout@v2
+            - uses: actions/setup-python@v1
+              with:
+                  python-version: ${{ matrix.python }}
+            - run: python -m pip install --upgrade pipenv wheel
+            - run: pipenv install
+            - run: pipenv run "pytest"

.github/workflows/quality-assurance.yaml

@@ -1,5 +1,19 @@
 # Changelog
 
+## [2.4.0] - 2021-02-03
+
+### Added
+
+* GitHub actions for tests (`quality-assurance.yaml`) and publishing to pypi (`pypi-publish.yaml`).
+
+### Changed 
+
+* named variable`prefix` on constructor renamed to `var_prefix`.
+
+### Removed
+
+* CircleCI action config. 
+
 ## [2.3.1] - 2019-11-04
 
 ### Added

CHANGELOG.md

@@ -1,6 +1,7 @@
 # Platform.sh Config Reader (Python)
 
-[![CircleCI Status](https://circleci.com/gh/platformsh/config-reader-python.svg?style=shield&circle-token=:circle-token)](https://circleci.com/gh/platformsh/config-reader-python)
+![Quality Assurance](https://github.com/platformsh/config-reader-python/workflows/Quality%20Assurance/badge.svg)
+![Publish (pypi)](https://github.com/platformsh/config-reader-python/workflows/Publish%20(pypi)/badge.svg)
 
 This library provides a streamlined and easy to use way to interact with a Platform.sh environment. It offers utility methods to access routes and relationships more cleanly than reading the raw environment variables yourself.
 

README.md

@@ -58,7 +58,7 @@ class Config:
 
     """
     Local index of the variables that can be accessed as direct properties (build and
-    runtime). The key is the property that will be read. The value is the environment variables, minus prefix,
+    runtime). The key is the property that will be read. The value is the environment variables, minus the variable prefix,
     that contains the value to look up.
     """
     _directVariables = {
@@ -97,7 +97,7 @@ class Config:
     """
     The vendor prefix for all environment variables we care about.
     """
-    _envPrefix = ''
+    _varPrefix = ''
 
     """
     The routes definition dict. Only available at runtime.
@@ -125,19 +125,19 @@ class Config:
     """
     _credentialFormatters = {}
 
-    def __init__(self, environment_variables=None, env_prefix='PLATFORM_'):
+    def __init__(self, environment_variables=None, var_prefix='PLATFORM_'):
         """Constructs a ConfigReader object.
 
         Args:
             environment_variables (dict):
                 The environment variables to read. Defaults to the current environment. Defaults to None.
-            env_prefix (string):
+            var_prefix (string):
                 The prefix for environment variables. Defaults to 'PLATFORM_'.
 
         """
 
         self._environmentVariables = os.environ if environment_variables is None else environment_variables
-        self._envPrefix = env_prefix
+        self._varPrefix = var_prefix
 
         if self['ROUTES']:
             routes = self['ROUTES']
@@ -232,7 +232,7 @@ def variable(self, name, default=None):
 
         Note:
             Variables prefixed with `env`: can be accessed as normal environment variables. This method will return
-            such a variable by the name with the prefix still included. Generally it's better to access those variables
+            such a variable by the name with the variable prefix still included. Generally it's better to access those variables
             directly.
 
         Args:
@@ -480,15 +480,15 @@ def has_relationship(self, relationship):
         return relationship in self._relationshipsDef
 
     def __getitem__(self, item):
-        """Reads an environment variable, taking the prefix into account.
+        """Reads an environment variable, taking the variable prefix into account.
 
         Args:
             item (string):
                 The variable to read.
 
         """
 
-        check_name = self._envPrefix + item.upper()
+        check_name = self._varPrefix + item.upper()
 
         return self._environmentVariables.get(check_name)
 

platformshconfig/config.py

@@ -12,7 +12,7 @@
 
 cwd = os.path.abspath(os.path.dirname(__file__))
 
-VERSION = "2.3.1"
+VERSION = "2.4.0"
 
 with open('README.md', 'r', encoding='utf-8') as f:
     __readme__ = f.read()
@@ -25,7 +25,7 @@ class VerifyVersionCommand(install):
     description = 'verify that the git tag matches our version'
 
     def run(self):
-        tag = os.getenv('CIRCLE_TAG')
+        tag = os.getenv('GHACTION_TAG')
 
         if tag != VERSION:
             info = "Git tag: {0} does not match the version of this app: {1}".format(