Merge pull request #62 from TrueLearnAI/release-1.0.0

Release TrueLearn 1.0.0

Author: KD-7

.github/workflows/black.yml

@@ -20,7 +20,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Actions Repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v3.5.2
 
       - name: Check format of TrueLearn
         uses: psf/black@stable

.github/workflows/clean_deployments.yml

@@ -0,0 +1,44 @@
+#
+# Cleans up a GitHub PR as we use deployments to share data between jobs (for python_publish.yml)
+# Code from https://github.com/strumwolf/delete-deployment-environment
+#
+name: 🧼 Clean up environment deployments
+on:
+  workflow_dispatch:
+
+  # To share the secrets between jobs for our Python Publish Action, we need to use
+  # an environment which creates multiple deployments.
+  # This action cleans up the GitHub PR when the deployments are no longer needed.
+  workflow_run:
+    workflows: ["Spell Check"]
+    types:
+      - completed
+
+jobs:
+  cleanup:
+    runs-on: ubuntu-latest
+    permissions: write-all
+
+    steps:
+      - uses: actions/[email protected]
+
+      # Points to a recent commit instead of `main` to avoid supply chain attacks.
+      - name: 🎟 Get GitHub App token
+        uses: navikt/[email protected]
+        id: get-token
+        with:
+          app-id: ${{ secrets.DEPLOYMENT_TOKEN_APP_ID }}
+          private-key: ${{ secrets.DEPLOYMENT_TOKEN_PRIVATE_KEY }}
+
+      # The behaviour of this action as configured is:
+      # ✔️ Deactivates deployment
+      # ✔️ Removes from deployments tab
+      # ❌ Removes from environment tab in settings (we want to keep our environments)
+      - name: 🗑 Delete deployment environment
+        uses: strumwolf/[email protected]
+        with:
+          # Use a JWT created with your GitHub App's private key
+          # ⚠️ The provided token needs permission for admin write:org
+          token: ${{ steps.get-token.outputs.token }}
+          environment: testing
+          onlyRemoveDeployments: true

.github/workflows/coverage.yml

@@ -27,10 +27,10 @@ jobs:
 
     steps:
       - name: Checkout Repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v3.5.2
 
       - name: Setup Python
-        uses: actions/setup-python@v4.4.0
+        uses: actions/setup-python@v4.5.0
         with:
           python-version: "3.7"
           cache: "pip" # cache dependencies

.github/workflows/python_publish.yml

@@ -44,10 +44,10 @@ jobs:
     needs: [unit_tests, static_analysis, format_check, typo_check]
     if: success()
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v3.5.2
 
       - name: Set up Python
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v4.5.0
         with:
           python-version: "3.7"
 

.github/workflows/static_analysis.yml

@@ -27,10 +27,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v3.5.2
 
       - name: Setup Python
-        uses: actions/setup-python@v4.4.0
+        uses: actions/setup-python@v4.5.0
         with:
           python-version: "3.7"
           cache: "pip" # cache dependencies
@@ -47,17 +47,8 @@ jobs:
           # Uses prospector.yml config file
           prospector --output-format xunit:prospector_report.xml
 
-      # Keep this commented out for now until prospector output format is fixed
-      # - name: Convert test results to Github Annotations
-      #  uses: check-run-reporter/[email protected]
-      # Change to failure() only if you want to only report on failures
-      # if: success()||failure()
-      #with:
-      # token: ${{ secrets.CHECK_RUN_REPORTER_TOKEN }}
-      #report: './prospector_report.xml'
-      #label: "Prospector Analysis Report"
-
-      # NOTE: Because it expects Junit format, the line numberings on the annotation header defaults to 1
+      # NOTE: Because it expects a Junit format,
+      # the line numberings on the annotation header defaults to 1
       # However the error message shows the correct line numbering.
       - name: Convert test results to Github Annotations
         uses: mikepenz/action-junit-report@v3

.github/workflows/typo.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Actions Repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v3.5.2
 
       - name: Check spelling of TrueLearn
         uses: crate-ci/typos@master

.github/workflows/unit_tests.yml

@@ -48,10 +48,10 @@ jobs:
       MPLBACKEND: "Agg"
     steps:
       - name: Checkout Repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v3.5.2
 
       - name: Setup Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4.4.0
+        uses: actions/setup-python@v4.5.0
         with:
           python-version: ${{ matrix.python-version }}
           cache: "pip" # cache dependencies

README.rst

@@ -38,7 +38,7 @@
    :target: https://github.com/psf/black
    :alt: Black
 
-.. |TrueLearn| image:: docs/images/TrueLearn_logo.png
+.. |TrueLearn| image:: https://raw.githubusercontent.com/truelearnai/truelearn/main/docs/images/TrueLearn_logo.png
    :target: https://truelearnai.github.io/
    :alt: TrueLearn
 

docs/changelog.rst

@@ -3,5 +3,5 @@ Change Log
 ----------
 This file documents all notable changes to the project.
 
-- TrueLearn 1.0.0 (31-03-2022)
-    - Initial release
+- TrueLearn 1.0.0 (13-04-2023)
+    - Initial release!

pyproject.toml

@@ -31,11 +31,18 @@ authors = [
 ]
 classifiers = [
     "License :: OSI Approved :: MIT License",
+    "Intended Audience :: Science/Research",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Education",
     "Programming Language :: Python :: 3.7",
     "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
+    "Development Status :: 5 - Production/Stable",
+    "Operating System :: Microsoft :: Windows",
+    "Operating System :: MacOS",
+    "Operating System :: Unix",
     "Topic :: Scientific/Engineering :: Artificial Intelligence",
     "Topic :: Software Development :: Libraries",
     "Topic :: Education",
@@ -50,14 +57,18 @@ dependencies = [
     'matplotlib>=3.5.3',
     'circlify>=0.15.0',
     "wordcloud>=1.8.2.2; python_version < '3.11'",
-    "kaleido>=0.2.1",
+
+    # This is a temporary fix for kaleido hanging on image generation on Windows
+    # See: https://github.com/plotly/Kaleido/issues/110
+    # and: https://github.com/plotly/Kaleido/issues/134
+    "kaleido==0.1.0.post1; sys_platform == 'win32'",
+    "kaleido>=0.2.1; sys_platform != 'win32'",
 ]
 [project.urls]
 Homepage = "https://truelearnai.github.io/"
 Documentation = "https://truelearn.readthedocs.io/en/stable/"
 Issues = "https://github.com/TrueLearnAI/truelearn/issues"
 Source = "https://github.com/TrueLearnAI/truelearn"
-ChangeLog = "https://github.com/TrueLearnAI/truelearn/blob/main/docs/changelog.rst"
 
 [tool.setuptools.dynamic]
 version = {attr = "truelearn.__version__"}