Merge pull request #17 from britive/develop

pypi

Author: twratl

.github/workflows/pypi-publish-on-push-on-new-release.yml

@@ -0,0 +1,33 @@
+# This workflow will upload to Test PyPi a Python Package using Twine when a new release is published
+
+name: Upload Python Package to PyPi
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.9'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/pypi-test-publish-on-push-to-develop-branch.yml

@@ -0,0 +1,35 @@
+# This workflow will upload to Test PyPi a Python Package using Twine when a push to develop branch occurs
+
+name: Upload Python Package to Test PyPi
+
+on:
+  push:
+    branches:
+      - develop
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.9'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_TEST_API_TOKEN }}
+        repository_url: https://test.pypi.org/legacy/

README.md

@@ -11,16 +11,13 @@ PyBritive is intended to be used as a CLI application for communicating with the
 
 ## Installation
 
-`pybritive` will be installed via Python `pip`. The package is not available in PyPi at this time, so it will be 
-installed via the published tar balls in the GitHub repo. Determine the most recent version that has been published
-and add the version below.
+`pybritive` will be installed via Python `pip`. 
 
 ~~~bash
-version=x.y.z
-pip install https://github.com/britive/python-cli/releases/download/v$version/pybritive-$version.tar.gz
+pip install pybritive
 ~~~
 
-Or you can always pull the latest version using one of the following commands
+Or you can always pull the latest version directly from Github using one of the following commands.
 
 ~~~
 pip install $(curl -s https://api.github.com/repos/britive/python-cli/releases/latest | jq -r '.assets[] | select(.content_type == "application/x-gzip") | .browser_download_url')

TECH_README.md

@@ -20,6 +20,12 @@ python -m build
 * Cut a new release in GitHub with the version tag
 * Add the assets from `dist` directory to the release
 
+## Github Actions
+There are 2 Github Actions in play that publish to PyPI.
+
+1. Trigger off of a push to the `develop` branch. Will deploy to test PyPI.
+2. Trigger off of a new release being published. Will deploy to real PyPI.
+
 ## Testing
 It is generally advisable to set environment variable `PYBRITIVE_HOME_DIR` to some temp location if you
 will be performing the full suite of tests. This will ensure that no changes are made to your existing

requirements.txt

@@ -1,4 +1,4 @@
-https://github.com/britive/python-sdk/releases/download/v2.7.1/britive-2.7.1.tar.gz
+britive~=2.7.1
 certifi==2022.6.15
 charset-normalizer==2.1.0
 click==8.1.3
@@ -13,4 +13,5 @@ urllib3==1.26.9
 cryptography==37.0.4
 pytest==7.1.2
 mkdocs==1.3.1
-mkdocs-click==0.8.0
+mkdocs-click==0.8.0
+twine~=4.0.1

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = pybritive
-version = 0.2.1
+version = 0.2.2
 author = Britive Inc.
 author_email = support@britive.com
 description = A pure Python CLI for Britive
@@ -25,7 +25,7 @@ install_requires =
     tabulate
     toml
     cryptography
-    britive @ https://github.com/britive/python-sdk/releases/download/v2.7.1/britive-2.7.1.tar.gz#egg=britive-2.7.1
+    britive
 
 [options.packages.find]
 where = src