Merge pull request #37 from nathanielvarona/automation/package-releases

Package Build/Publish to PyPI and Upload Release Assets

.editorconfig

@@ -14,6 +14,12 @@ charset = utf-8
 indent_style = space
 indent_size = 4
 
-# Tab indentation (no size specified)
-[Makefile]
-indent_style = tab
+# YAML files
+[*.{yaml,yml}]
+indent_style = space
+indent_size = 2
+
+# YAML files
+[*.{md}]
+indent_style = space
+indent_size = 2

.github/workflows/release.yml

@@ -0,0 +1,46 @@
+name: Build the Package Release Assets
+
+on:
+  release:
+    types: [released]
+
+jobs:
+  build-package-and-release-assets:
+    permissions:
+      contents: write
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+
+      - name: Setup Poetry and Configure PyPI
+        run: |
+          # Setup Poetry
+          pipx install poetry==1.8.2
+
+          # Configure PyPI Repository and Credentials
+          poetry config repositories.pypi ${{ secrets.PYPI_REPOSITORIES }}
+          poetry config pypi-token.pypi ${{ secrets.PYPI_TOKEN }}
+
+      - name: Build the Package
+        run: |
+          # Build the Package
+          poetry build --output=./dist
+
+      - name: Publish the Package to PyPI
+        run: |
+          # Publish the Package to PyPI
+          poetry publish --repository pypi
+
+      - name: Upload as Release Assets
+        uses: softprops/action-gh-release@v2
+        if: startsWith(github.ref, 'refs/tags/')
+        with:
+          files: |
+            ./dist/*
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -27,8 +27,8 @@ Before using the API library including the use of the CLI feature, we need to pr
 
 ```bash
 export PRITUNL_BASE_URL="https://vpn.domain.tld/"
-export PRITUNL_API_TOKEN="XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
-export PRITUNL_API_SECRET="XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
+export PRITUNL_API_TOKEN="<PRITUNL API TOKEN>"
+export PRITUNL_API_SECRET="<PRITUNL API SECRET>"
 ```
 
 Initializing an API Instance.
@@ -42,7 +42,7 @@ pritunl = Pritunl()
 
 ## You can also initialize an instance by manually providing the arguments.
 # pritunl = Pritunl(
-#   url="<PRITUNL API URL>",
+#   url="<PRITUNL BASE URL>",
 #   token="<PRITUNL API TOKEN>",
 #   secret="<PRITUNL API SECRET>"
 # )