Merge pull request #21 from google/packaging

Package for PyPI

Author: obsidianforensics

.github/workflows/publish-to-pypi.yml

@@ -0,0 +1,38 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build-n-publish:
+    name: Build and publish Python 🐍 distributions 📦 to PyPI
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/dfiq
+    permissions:
+      id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
+    steps:
+    - uses: actions/checkout@master
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v1
+      with:
+        python-version: '3.10' 
+    - name: Install pypa/build
+      run: >-
+        python -m
+        pip install
+        build
+        --user
+    - name: Build a binary wheel and a source tarball
+      run: >-
+        python -m
+        build
+        --sdist
+        --wheel
+        --outdir dist/
+        .
+    - name: Publish distribution 📦 to PyPI
+      if: startsWith(github.ref, 'refs/tags/')
+      uses: pypa/gh-action-pypi-publish@release/v1

README.md

@@ -0,0 +1,6 @@
+from .dfiq import DFIQ, Scenario, Facet, Question, Approach
+
+__all__ = ["DFIQ", "Scenario", "Facet", "Question", "Approach"]
+__version__ = "1.0.1"
+__author__ = "Ryan Benson"
+__email__ = "ryan@dfir.blog"