Merge pull request #661 from atsign-foundation/chore/organize-packages

chore: organize packages

.github/composite/verify_cli_tags/action.yaml

@@ -8,7 +8,7 @@ runs:
     - name: Ensure pubspec.yaml matches git ref (if current git ref is a version tag)
       shell: bash
       if: startsWith(github.ref, 'refs/tags/v')
-      working-directory: ./packages/sshnoports
+      working-directory: ./packages/dart/sshnoports
       run: |
         REF=${{ github.ref }}
         TAG=${REF:10}

.github/dependabot.yml

@@ -7,19 +7,19 @@ updates:
     schedule:
       interval: "daily"
   - package-ecosystem: "docker"
-    directory: "/packages/sshnoports/tools/"
+    directory: "/packages/dart/sshnoports/tools/"
     schedule:
       interval: "daily"
   - package-ecosystem: "docker"
     directory: "/tests/end2end_tests/image/"
     schedule:
       interval: "daily"
   - package-ecosystem: "pub"
-    directory: "/packages/sshnoports/"
+    directory: "/packages/dart/sshnoports/"
     schedule:
       interval: "daily"
   - package-ecosystem: "pub"
-    directory: "/packages/sshnp_gui/"
+    directory: "/packages/dart/sshnp_gui/"
     schedule:
       interval: "daily"
   - package-ecosystem: "pip"

.github/workflows/dockerhub_sshnpd.yml

@@ -15,9 +15,9 @@ jobs:
       matrix:
         include:
           - name: sshnpd
-            dockerfile: ./packages/sshnoports/tools/Dockerfile
+            dockerfile: ./packages/dart/sshnoports/tools/Dockerfile
           - name: activate_sshnpd
-            dockerfile: ./packages/sshnoports/tools/Dockerfile.activate
+            dockerfile: ./packages/dart/sshnoports/tools/Dockerfile.activate
     runs-on: ubuntu-latest
     steps:
       - name: Checkout

.github/workflows/multibuild.yaml

@@ -23,7 +23,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     defaults:
       run:
-        working-directory: ./packages/sshnoports
+        working-directory: ./packages/dart/sshnoports
     strategy:
       matrix:
         os: [ubuntu-latest, macOS-latest, windows-latest]
@@ -67,7 +67,7 @@ jobs:
       - uses: actions/upload-artifact@c7d193f32edcb7bfad88892161225aeda64e9392 # v4.0.0
         with:
           name: x64_binaries
-          path: ./packages/sshnoports/tarball/${{ matrix.output-name }}.tgz
+          path: ./packages/dart/sshnoports/tarball/${{ matrix.output-name }}.tgz
           if-no-files-found: error
 
   other_build:
@@ -76,7 +76,7 @@ jobs:
     runs-on: ubuntu-latest
     defaults:
       run:
-        working-directory: ./packages/sshnoports
+        working-directory: ./packages/dart/sshnoports
     strategy:
       matrix:
         platform: [linux/arm/v7, linux/arm64, linux/riscv64]
@@ -99,7 +99,7 @@ jobs:
       - uses: actions/upload-artifact@c7d193f32edcb7bfad88892161225aeda64e9392 # v4.0.0
         with:
           name: other_binaries
-          path: ./packages/sshnoports/tarballs/${{ matrix.output-name }}.tgz
+          path: ./packages/dart/sshnoports/tarballs/${{ matrix.output-name }}.tgz
           if-no-files-found: error
 
   notify_on_completion:

.github/workflows/unit_tests.yaml

@@ -29,19 +29,19 @@ jobs:
           go-version: 'stable'
           cache-dependency-path: tools/osv-scanner/go.sum
       - name: dart pub get
-        working-directory: packages/noports_core
+        working-directory: packages/dart/noports_core
         run: dart pub get
       - name: dart analyze
-        working-directory: packages/noports_core
+        working-directory: packages/dart/noports_core
         run: dart analyze
       - name: dart test
-        working-directory: packages/noports_core
+        working-directory: packages/dart/noports_core
         run: dart test
       # Runs osv-scanner to find any vulnerable Dart dependencies
       # It needs to look at pubspec.lock files, which is why it's
       # placed here, as the `dart pub get` above will create them
       - name: Run osv-scanner
-        working-directory: packages
+        working-directory: packages/dart
         run: |
           go install github.com/google/osv-scanner/cmd/osv-scanner@6316373e47d7e3e4b4fd3630c4bbc10987738de6 # v1.4.3
           osv-scanner --lockfile=./sshnoports/pubspec.lock

.vscode/launch.json

@@ -18,7 +18,7 @@
       "type": "python",
       "request": "launch",
       "cwd": "",
-      "program": "packages/sshnpdpy/sshnpd.py",
+      "program": "packages/python/sshnpdpy/sshnpd.py",
       "console": "integratedTerminal",
       "justMyCode": true,
       "envFile": "${workspaceFolder}/.env",

README.md

@@ -7,5 +7,5 @@
 # noports
 This repo contains the open source code of the Atsign's No Ports suite. Check out our product site at [noports.com](https://noports.com).
 
-* [sshnoports](./packages/sshnoports) provides a way to ssh to a remote linux host/device without that
+* [sshnoports](./packages/dart/sshnoports) provides a way to ssh to a remote linux host/device without that
 device or the client having any open ports (not even 22) on external interfaces.

examples/.gitignore

@@ -0,0 +1 @@
+webserver/

examples/automations/python/README.md

@@ -0,0 +1,10 @@
+# sshnoports automation python
+
+This "sdk" serves as an example for how to wrap and use an sshnp client in
+python scripts for automation purposes.
+
+## Experimental Status
+
+These scripts were written as an example for how to build your own automations.
+They are incomplete and untested, reference for your own material.
+Use at your own risk.

packages/python/sshnoports_sdk/pyproject.toml → examples/automations/python/pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
-name = "sshnoports_sdk_python"
+name = "sshnoports_automation_python"
 version = "0.0.1"
-description = "A simple python SDK which allows you to create scripts for common administrative patterns via SSH No Ports"
+description = "Some python recipes which allows you to create scripts for common administrative patterns via SSH No Ports"
 authors = ["Chris Swan <@cpswan>"]
 readme = "README.md"
 

melos.yaml

@@ -1,9 +1,9 @@
 name: sshnoports
 
 packages:
-  - packages/noports_core
-  - packages/sshnoports
-  - packages/sshnp_gui
+  - packages/dart/noports_core
+  - packages/dart/sshnoports
+  - packages/dart/sshnp_gui
 
 command:
   bootstrap:

packages/noports_core/README.md → packages/dart/noports_core/README.md

@@ -11,11 +11,11 @@ No Ports Core is the underlying library used to enable sshnoports and the rest o
 
 ### CLI Example
 
-See the [sshnoports](https://github.com/atsign-foundation/noports/tree/trunk/packages/sshnoports) project.
+See the [sshnoports](https://github.com/atsign-foundation/noports/tree/trunk/packages/dart/sshnoports) project.
 
 ### Flutter Example
 
-See the [sshnp_gui](https://github.com/atsign-foundation/noports/tree/trunk/packages/sshnp_gui) project.
+See the [sshnp_gui](https://github.com/atsign-foundation/noports/tree/trunk/packages/dart/sshnp_gui) project.
 
 ## Maintainers
 

packages/sshnoports/tools/Dockerfile → packages/dart/sshnoports/tools/Dockerfile

@@ -2,7 +2,7 @@
 # Build image for a containerized instance of sshnpd
 
 FROM dart:3.2.4@sha256:a310da69472710ceaa8015add37ef99d16d9ec51e9b67f87fe3b11a7e9596a50 AS buildimage
-ENV PACKAGEDIR=packages/sshnoports
+ENV PACKAGEDIR=packages/dart/sshnoports
 ENV BINARYDIR=/usr/local/at
 SHELL ["/bin/bash", "-c"]
 WORKDIR /app
@@ -24,7 +24,7 @@ ENV BINARYDIR=/usr/local/at
 ENV USER_ID=1024
 ENV GROUP_ID=1024
 
-COPY --from=buildimage /app/packages/sshnoports/bundles/core/docker/.startup.sh ${HOMEDIR}/
+COPY --from=buildimage /app/packages/dart/sshnoports/bundles/core/docker/.startup.sh ${HOMEDIR}/
 RUN \
   set -eux ; \
   apt-get update ; \

packages/sshnoports/tools/Dockerfile.activate → packages/dart/sshnoports/tools/Dockerfile.activate

@@ -1,7 +1,7 @@
 # Dockerfile.activate
 # Build image for a containerized call of the at_activate binary
 FROM dart:3.2.4@sha256:a310da69472710ceaa8015add37ef99d16d9ec51e9b67f87fe3b11a7e9596a50 AS buildimage
-ENV PACKAGEDIR=packages/sshnoports
+ENV PACKAGEDIR=packages/dart/sshnoports
 ENV BINARYDIR=/usr/local/at
 SHELL ["/bin/bash", "-c"]
 WORKDIR /app

packages/sshnoports/tools/docker-compose.local.yaml → packages/dart/sshnoports/tools/docker-compose.local.yaml

@@ -3,14 +3,14 @@ services:
   activate:
     build:
       context: ../../../ # root of the repo
-      dockerfile: ./packages/sshnoports/tools/Dockerfile.activate
+      dockerfile: ./packages/dart/sshnoports/tools/Dockerfile.activate
     volumes:
       - ${HOME}/.atsign/keys:/atsign/.atsign/keys
     command: -a "${TO}" -c "${TO_CRAM}"
   sshnpd:
     build:
       context: ../../../ # root of the repo
-      dockerfile: ./packages/sshnoports/tools/Dockerfile
+      dockerfile: ./packages/dart/sshnoports/tools/Dockerfile
     volumes:
       - ${HOME}/.atsign/keys:/atsign/.atsign/keys
     command: -a "${TO}" -m "${FROM}" -d "${DEVICE}" -s -u -v