Use bsk from PyPi for builds

.github/actions/build/action.yml

@@ -0,0 +1,26 @@
+name: build
+description: >
+  Prepares the Python environment for BSK-RL, installs the project in editable
+  mode with its dependencies, and fetches the Basilisk large data.
+
+inputs:
+  python-version:
+    required: true
+    type: string
+    default: "3.11"
+  pip-options:
+    type: string
+    default: "all"
+runs:
+  using: "composite"
+  steps:
+    - name: Set up Python ${{ inputs.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ inputs.python-version }}
+    - name: Install BSK-RL
+      shell: bash
+      run: pip install -e '.[${{ inputs.pip-options }}]'
+    - name: Install large data
+      shell: bash
+      run: bskLargeData

.github/workflows/commit_checks.yml

@@ -18,19 +18,19 @@ jobs:
         uses: gsactions/commit-message-checker@v2
         with:
           pattern: '((Issue \#[0-9]+:)|(\[((\#[0-9]+)|(MINOR)|(AUTO)|(RELEASE))\])) .+'
-          checkAllCommitMessages: 'true'
+          checkAllCommitMessages: "true"
           error: 'Your first line has to have the format "Issue #XXX: Commit message" or "[#XXX] Commit Message".'
-          excludeDescription: 'true'
-          excludeTitle: 'true'
+          excludeDescription: "true"
+          excludeTitle: "true"
           accessToken: ${{ secrets.GITHUB_TOKEN }}
       - name: Check Line Length
         uses: gsactions/commit-message-checker@v2
         with:
-          pattern: '.{1,72}'
-          error: 'The maximum line length of 72 characters is exceeded.'
-          excludeDescription: 'true'
-          excludeTitle: 'true'
-          checkAllCommitMessages: 'true'
+          pattern: ".{1,72}"
+          error: "The maximum line length of 72 characters is exceeded."
+          excludeDescription: "true"
+          excludeTitle: "true"
+          checkAllCommitMessages: "true"
           accessToken: ${{ secrets.GITHUB_TOKEN }}
 
   run-pytest:
@@ -42,7 +42,7 @@ jobs:
         python-version: ["3.10", "3.11"]
     steps:
       - uses: actions/checkout@v4
-      - uses: ./.github/actions/install-bsk-rl
+      - uses: ./.github/actions/build
         with:
           python-version: ${{ matrix.python-version }}
       - name: Run pytest
@@ -54,7 +54,7 @@ jobs:
     steps:
       - uses: pandoc/actions/setup@main
       - uses: actions/checkout@v4
-      - uses: ./.github/actions/install-bsk-rl
+      - uses: ./.github/actions/build
         with:
           python-version: 3.11
           pip-options: all,rllib,docs

.github/workflows/documentation.yml

@@ -4,13 +4,12 @@ on:
   push:
     branches:
       - develop
-  
+
 # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
 permissions:
-    contents: write
-    pages: write
-    id-token: write
-
+  contents: write
+  pages: write
+  id-token: write
 
 concurrency:
   group: ${{ github.workflow }}
@@ -22,7 +21,7 @@ jobs:
     steps:
       - uses: pandoc/actions/setup@main
       - uses: actions/checkout@v4
-      - uses: ./.github/actions/install-bsk-rl
+      - uses: ./.github/actions/build
         with:
           python-version: 3.11
           pip-options: all,rllib,docs
@@ -36,5 +35,3 @@ jobs:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./docs/build/html
           force_orphan: true
-
-

.github/workflows/pull_request_closed.yml

@@ -1,30 +1,29 @@
 name: "Pull Request Closed"
 
 on:
-    pull_request:
-        types:
-            - closed
-        branches:
-            - develop
-    workflow_dispatch:
+  pull_request:
+    types:
+      - closed
+    branches:
+      - develop
+  workflow_dispatch:
 
 jobs:
-    if_merged:
-        if: github.event.pull_request.merged == true
-        runs-on: ubuntu-latest
-        steps:
-        - name: Pull repo
-          uses: actions/checkout@v4
-          with:
-            ref: develop
-            fetch-depth: 0
-            token: ${{ secrets.BOT_ACCESS_TOKEN }}
-        - name: Bump version
-          run: ./.github/workflows/version_bumper.sh ./pyproject.toml
-        - name: Commit and push
-          run: |
-              git config user.name "AVSlabBot"
-              git config user.email "[email protected]"
-              git commit -a -m "[AUTO] Bump minor version number"
-              git push
-
+  if_merged:
+    if: github.event.pull_request.merged == true
+    runs-on: ubuntu-latest
+    steps:
+      - name: Pull repo
+        uses: actions/checkout@v4
+        with:
+          ref: develop
+          fetch-depth: 0
+          token: ${{ secrets.BOT_ACCESS_TOKEN }}
+      - name: Bump version
+        run: ./.github/workflows/version_bumper.sh ./pyproject.toml
+      - name: Commit and push
+        run: |
+          git config user.name "AVSlabBot"
+          git config user.email "[email protected]"
+          git commit -a -m "[AUTO] Bump minor version number"
+          git push

docs/source/release_notes.rst

@@ -8,6 +8,8 @@ Development - |version|
   that can be used with :class:`~bsk_rl.comm.BroadcastCommunication` to only communicate
   data when the action has been called.
 * Add example script for shielded training with action replacement and action masking in `Shielded training with action masking and action replacement <examples/training_with_shield.ipynb>`_.
+* Add ``bsk`` as a dependency in ``pyproject.toml``.
+* Update the CI/CD workflows to build BSK-RL using the new ``bsk`` dependency.
 
 
 Version 1.2.0

pyproject.toml

@@ -14,6 +14,7 @@ readme = "README.md"
 requires-python = ">=3.10.0"
 license = { text = "MIT" }
 dependencies = [
+    "bsk>=2.8.9",
     "Deprecated",
     "gymnasium",
     "numpy",

src/bsk_rl/__init__.py

@@ -1,7 +1,6 @@
 import gymnasium as gym
 from gymnasium.envs.registration import register
 
-from bsk_rl.check_bsk_version import check_bsk_version
 from bsk_rl.gym import (
     NO_ACTION,
     ConstellationTasking,
@@ -29,5 +28,3 @@
     id="ConstellationTasking-v1",
     entry_point="bsk_rl.gym:ConstellationTasking",
 )
-
-check_bsk_version()