bitswan 0.0.0__tar.gz

bitswan-0.0.0/.coveragerc

@@ -0,0 +1,5 @@
+[run]
+source=bspump/
+
+[report]
+include=bspump*

bitswan-0.0.0/.github/workflows/bitswan-release.yml

@@ -0,0 +1,90 @@
+name: Release Workflow (PyPI, GitHub Release)
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  build-and-upload-pypi:
+    name: Build and Upload PyPI Package
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.9
+
+      - name: Install build tools
+        run: pip install build twine
+
+      - name: Generate CalVer version
+        id: calver
+        run: |
+          # Get current date in YYYY.MM.DD format
+          DATE_VERSION=$(date +%Y.%m.%d)
+          # Get GitHub run number
+          BUILD_NUMBER=${{ github.run_number }}
+          # Combine for final version
+          CALVER_VERSION="${DATE_VERSION}.${BUILD_NUMBER}"
+          echo "version=${CALVER_VERSION}" >> $GITHUB_OUTPUT
+          echo "Generated CalVer version: ${CALVER_VERSION}"
+
+      - name: Update version in __version__.py
+        run: |
+          # Update the version in bspump/__version__.py
+          sed -i "s/__version__ = .*/__version__ = \"${{ steps.calver.outputs.version }}\"/" bspump/__version__.py
+          cat bspump/__version__.py
+
+      - name: Build package
+        run: python -m build
+
+      - name: Upload to PyPI
+        env:
+          TWINE_USERNAME: "__token__"
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+        run: twine upload dist/*
+
+  create-github-release:
+    name: Create GitHub Release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Generate CalVer version
+        id: calver
+        run: |
+          # Get current date in YYYY.MM.DD format
+          DATE_VERSION=$(date +%Y.%m.%d)
+          # Get GitHub run number
+          BUILD_NUMBER=${{ github.run_number }}
+          # Combine for final version
+          CALVER_VERSION="${DATE_VERSION}.${BUILD_NUMBER}"
+          echo "version=${CALVER_VERSION}" >> $GITHUB_OUTPUT
+          echo "Generated CalVer version: ${CALVER_VERSION}"
+
+      - name: Create GitHub Release
+        uses: actions/create-release@v1
+        with:
+          tag_name: "v${{ steps.calver.outputs.version }}"
+          release_name: "Release v${{ steps.calver.outputs.version }}"
+          body: |
+            ## CalVer Release v${{ steps.calver.outputs.version }}
+            
+            **Release Date:** $(date +%Y-%m-%d)
+            **Build Number:** ${{ github.run_number }}
+            **Commit:** ${{ github.sha }}
+            
+            This is an automated release triggered by a push to master.
+          draft: false
+          prerelease: false
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

bitswan-0.0.0/.github/workflows/docker-publish-dockserver.yml

@@ -0,0 +1,33 @@
+name: Build and Push Dockserver Docker Image
+
+on:
+  push:
+    branches: [ master ]
+    paths:
+      - 'docserver/**'
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Check out the repo
+      uses: actions/checkout@v2
+
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v1
+
+    - name: Log in to Docker Hub
+      uses: docker/login-action@v1
+      with:
+        username: ${{ secrets.DOCKERHUB_USERNAME }}
+        password: ${{ secrets.DOCKERHUB_ACCESS_TOKEN }}
+
+    - name: Get Year and Commit Hash
+      id: vars
+      run: |
+        echo "::set-output name=year::$(date +%Y)"
+        echo "::set-output name=commit_hash::$(git rev-parse --short HEAD)"
+
+    - name: Build and Push
+      run: bash docserver/build_and_push.sh

bitswan-0.0.0/.github/workflows/docker-publish.yml

@@ -0,0 +1,31 @@
+name: Build and Push Docker Image
+
+on:
+  push:
+    branches: [ master ]
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Check out the repo
+      uses: actions/checkout@v2
+
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v1
+
+    - name: Log in to Docker Hub
+      uses: docker/login-action@v1
+      with:
+        username: ${{ secrets.DOCKERHUB_USERNAME }}
+        password: ${{ secrets.DOCKERHUB_ACCESS_TOKEN }}
+
+    - name: Get Year and Commit Hash
+      id: vars
+      run: |
+        echo "::set-output name=year::$(date +%Y)"
+        echo "::set-output name=commit_hash::$(git rev-parse --short HEAD)"
+
+    - name: Build and Push
+      run: bash build_and_push.sh

bitswan-0.0.0/.github/workflows/test.yml

@@ -0,0 +1,36 @@
+name: Python 3.13 Test
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    container:
+      image: python:3.13
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Install dependencies
+      run: |
+        apt-get update
+        apt-get -y install unixodbc-dev
+        git config --global --add safe.directory /__w/BitSwan/BitSwan
+        pip3 install --upgrade cython
+        pip3 install .[dev]
+
+    - name: Run tests
+      run: |
+        pytest bspump/file
+
+    - name: Run bitswan tests
+      run: |
+        bitswan-notebook --test examples/Testing/main.ipynb
+        bitswan-notebook --test examples/Testing/MultiplePipelines/main.ipynb
+        bitswan-notebook --test examples/Testing/AutoPipeline/main.ipynb
+
+
+    - name: Run linter
+      run: |
+        black --check bspump
+        ruff check bspump

bitswan-0.0.0/.gitignore

@@ -0,0 +1,118 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+*.dot
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# dotenv
+.env
+
+# virtualenv
+.venv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# idea
+.idea/
+
+# ignoring site configuration
+etc/site.conf
+etc/site.d/
+
+# ignoring example outputs
+examples/data/ignore_*
+
+doc/_build
+
+# VSCode
+.vscode/
+

bitswan-0.0.0/.gitlab-ci.yml

@@ -0,0 +1,23 @@
+variables:
+  DOCKER_IMAGE: bitswan-pre
+
+stages:
+  - test
+  - build
+
+test-py310:
+  image: python:3.10
+  stage: test
+  coverage: '/\d+\%$/'
+  script:
+    - apt-get update
+    - apt-get -y install unixodbc-dev
+    - pip3 install --upgrade cython
+    - pip3 install .
+    - pip install -r requirements-dev.txt
+    - pytest bspump/file
+    - ruff bspump
+
+include:
+  - project: 'LibertyAces/Product/bitswanmonorepo'
+    file: 'cicd/docker-build-public.yml'

bitswan-0.0.0/Dockerfile

@@ -0,0 +1,45 @@
+FROM python:3.13-slim-bookworm
+MAINTAINER LibertyAces Ltd
+LABEL "space.bitswan.pipeline.protocol-version"="2023.12-1"
+LABEL "space.bitswan.pipeline.ide"="Jupyter"
+LABEL src=https://github.com/bitswan-space/BitSwan
+ENV ASABFORCECONSOLE=1
+ENV PYTHONUNBUFFERED=1
+
+RUN set -ex \
+ && apt-get update \
+ && apt-get -y upgrade
+
+RUN apt-get -yqq install \
+ git \
+ gcc \
+ g++ \
+ libsnappy-dev \
+ autoconf \
+ automake \
+ libtool \
+ build-essential \
+ docker-compose
+
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /uvx /bin/
+
+COPY . /src/
+
+RUN apt-get remove -y python3-yaml && apt-get autoremove -y
+
+RUN cd /src/ && uv pip install --system .
+
+COPY pre/ /opt/
+
+CMD ["sh", "/opt/entrypoint.sh"]
+
+# Setup bitswan user
+
+RUN useradd --uid 1000 --create-home bitswan
+ENV HOME=/home/bitswan
+USER bitswan
+
+USER root
+RUN mkdir -p /home/bitswan/work
+RUN chown -R bitswan:bitswan /home/bitswan/work
+

bitswan-0.0.0/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2018-2019, LibertyAces Ltd 
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

bitswan-0.0.0/MANIFEST.in

@@ -0,0 +1,3 @@
+include *.txt *.md
+recursive-include bspump/static *
+recursive-include data *.css

bitswan-0.0.0/PKG-INFO

@@ -0,0 +1,163 @@
+Metadata-Version: 2.4
+Name: bitswan
+Version: 0.0.0
+Summary: Bitswan is a framework for building automations and pipelines in Jupyter
+Project-URL: homepage, https://github.com/bitswan-space/BitSwan
+Author-email: LibertyAces Ltd <timothy.hobbs@libertyaces.com>
+License: BSD 3-Clause License
+        
+        Copyright (c) 2018-2019, LibertyAces Ltd 
+        All rights reserved.
+        
+        Redistribution and use in source and binary forms, with or without
+        modification, are permitted provided that the following conditions are met:
+        
+        * Redistributions of source code must retain the above copyright notice, this
+          list of conditions and the following disclaimer.
+        
+        * Redistributions in binary form must reproduce the above copyright notice,
+          this list of conditions and the following disclaimer in the documentation
+          and/or other materials provided with the distribution.
+        
+        * Neither the name of the copyright holder nor the names of its
+          contributors may be used to endorse or promote products derived from
+          this software without specific prior written permission.
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+License-File: LICENSE
+Requires-Dist: aiohttp>=3.8.3
+Requires-Dist: aiomysql>=0.2.0
+Requires-Dist: aiosmtplib>=1.1.3
+Requires-Dist: aiozk>=0.25.0
+Requires-Dist: certifi>=2023.7.22
+Requires-Dist: confluent-kafka>=1.8.2
+Requires-Dist: croniter>=1.4.1
+Requires-Dist: cryptography>=44.0.1
+Requires-Dist: docker
+Requires-Dist: dockerfile-parse
+Requires-Dist: fastavro>=0.23.5
+Requires-Dist: fastjsonschema<3,>=2.16.2
+Requires-Dist: google-api-python-client>=1.7.10
+Requires-Dist: idna>=3.7
+Requires-Dist: importlib-resources
+Requires-Dist: jinja2>=3.1.6
+Requires-Dist: jupyter
+Requires-Dist: kazoo<3,>=2.9.0
+Requires-Dist: matplotlib==3.8.0
+Requires-Dist: mongoquery>=1.3.6
+Requires-Dist: motor>=2.1.0
+Requires-Dist: mysql-replication>=0.21
+Requires-Dist: nest-asyncio==1.6.0
+Requires-Dist: netaddr>=0.7.20
+Requires-Dist: numpy>=1.19.0
+Requires-Dist: orjson
+Requires-Dist: paho-mqtt
+Requires-Dist: pandas>=0.24.2
+Requires-Dist: pika>=1.1.0
+Requires-Dist: pyasn1==0.4.8
+Requires-Dist: pybind11>=2.6.1
+Requires-Dist: pyjwt==v2.10.1
+Requires-Dist: pymongo>=3.10.1
+Requires-Dist: pymysql>=1.1.1
+Requires-Dist: python-dotenv==1.0.1
+Requires-Dist: pytz>=2020.1
+Requires-Dist: pyyaml>=5.4
+Requires-Dist: requests>=2.32.0
+Requires-Dist: setuptools>=70.0.0
+Requires-Dist: urllib3>=1.26.19
+Requires-Dist: xxhash>=1.4.4
+Requires-Dist: zipp>=3.19.1
+Provides-Extra: dev
+Requires-Dist: black==23.1.0; extra == 'dev'
+Requires-Dist: coverage==4.5.3; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-asyncio; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Requires-Dist: watchdog==6.0.0; extra == 'dev'
+Provides-Extra: pyjq-support
+Requires-Dist: pyjq>=2.6.0; extra == 'pyjq-support'
+Description-Content-Type: text/markdown
+
+Bitswan: A tool for building Pipelines & Automations in Jupyter
+===============================================
+
+You can find example pipelines in the [examples](./examples/) directory.
+
+Installation
+--------------
+
+This library is part of the bitswan suite which is managed by the bitswan workspace cli.
+You must first install the [bitswan workspaces](https://github.com/bitswan-space/bitswan-workspaces) cli before installing and using the bitswan notebooks cli.
+
+```
+$ git clone git@github.com:bitswan-space/BitSwan.git
+$ cd BitSwan
+$ curl -LsSf https://astral.sh/uv/install.sh | sh
+$ uv venv
+$ source .venv/bin/activate
+$ uv pip install -e ".[dev]"
+```
+
+Running pipelines
+--------------------
+
+You can run a pipeline with a simple command:
+
+```
+$ bitswan notebook examples/WebForms/main.ipynb
+```
+
+When developing web endpoints it can be helpful to instruct the pipeline to automatically restart if the source code changes.
+
+```
+$ bitswan notebook examples/WebForms/main.ipynb --watch
+```
+
+Running Tests
+----------------
+
+You can find examples for automatically testing pipelines in the [testing examples](./examples/Testing) directory.
+
+Run tests with the `--test` flag.
+
+```
+$ bitswan notebook examples/Testing/InspectError/main.ipynb --test
+
+Running tests for pipeline Kafka2KafkaPipeline.
+
+    ┌ Testing event:        b'foo'
+    └ Outputs:              [b'FOO'] ✔
+
+All tests passed for Kafka2KafkaPipeline.
+
+
+Running tests for pipeline auto_pipeline_1.
+
+    ┌ Testing event:        b'{"foo":"aaa"}'
+    └ Outputs:              [b'{"foo": "A   A   A"}'] ✔
+
+    ┌ Testing event:        b'{"foo":"aab"}'
+    │ Probing after-upper.
+    └ Outputs:              [b'{"foo": "B   A   A"}'] ✔
+
+    ┌ Testing event:        b'{"foo":"cab"}'
+    └ Outputs:              [b'{"foo": "B   A   C"}'] ✘
+```
+
+You can combine `--test` with `--watch` to automatically rerun tests whenever the source files change.
+
+
+Licence
+-------
+
+Bitswan is open-source software, available under BSD 3-Clause License.
+

bitswan-0.0.0/README.md

@@ -0,0 +1,74 @@
+Bitswan: A tool for building Pipelines & Automations in Jupyter
+===============================================
+
+You can find example pipelines in the [examples](./examples/) directory.
+
+Installation
+--------------
+
+This library is part of the bitswan suite which is managed by the bitswan workspace cli.
+You must first install the [bitswan workspaces](https://github.com/bitswan-space/bitswan-workspaces) cli before installing and using the bitswan notebooks cli.
+
+```
+$ git clone git@github.com:bitswan-space/BitSwan.git
+$ cd BitSwan
+$ curl -LsSf https://astral.sh/uv/install.sh | sh
+$ uv venv
+$ source .venv/bin/activate
+$ uv pip install -e ".[dev]"
+```
+
+Running pipelines
+--------------------
+
+You can run a pipeline with a simple command:
+
+```
+$ bitswan notebook examples/WebForms/main.ipynb
+```
+
+When developing web endpoints it can be helpful to instruct the pipeline to automatically restart if the source code changes.
+
+```
+$ bitswan notebook examples/WebForms/main.ipynb --watch
+```
+
+Running Tests
+----------------
+
+You can find examples for automatically testing pipelines in the [testing examples](./examples/Testing) directory.
+
+Run tests with the `--test` flag.
+
+```
+$ bitswan notebook examples/Testing/InspectError/main.ipynb --test
+
+Running tests for pipeline Kafka2KafkaPipeline.
+
+    ┌ Testing event:        b'foo'
+    └ Outputs:              [b'FOO'] ✔
+
+All tests passed for Kafka2KafkaPipeline.
+
+
+Running tests for pipeline auto_pipeline_1.
+
+    ┌ Testing event:        b'{"foo":"aaa"}'
+    └ Outputs:              [b'{"foo": "A   A   A"}'] ✔
+
+    ┌ Testing event:        b'{"foo":"aab"}'
+    │ Probing after-upper.
+    └ Outputs:              [b'{"foo": "B   A   A"}'] ✔
+
+    ┌ Testing event:        b'{"foo":"cab"}'
+    └ Outputs:              [b'{"foo": "B   A   C"}'] ✘
+```
+
+You can combine `--test` with `--watch` to automatically rerun tests whenever the source files change.
+
+
+Licence
+-------
+
+Bitswan is open-source software, available under BSD 3-Clause License.
+