Merge pull request bitcoin-dev-project#377 from willcl-ark/package

Package for pypi

Author: m3dwards

.github/workflows/publish-dist.yml

@@ -0,0 +1,94 @@
+name: Publish Python 🐍 distribution 📦 to PyPI
+
+on: push
+
+jobs:
+  build:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.x"
+    - name: Install pypa/build
+      run: >-
+        python3 -m
+        pip install
+        build
+        --user
+    - name: Build a binary wheel and a source tarball
+      run: python3 -m build
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v3
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  publish-to-pypi:
+    name: >-
+      Publish Python 🐍 distribution 📦 to PyPI
+    if: startsWith(github.ref, 'refs/tags/')  # only publish to PyPI on tag pushes
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/warnet
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v3
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution 📦 to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    name: >-
+      Sign the Python 🐍 distribution 📦 with Sigstore
+      and upload them to GitHub Release
+    needs:
+    - publish-to-pypi
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write  # IMPORTANT: mandatory for making GitHub Releases
+      id-token: write  # IMPORTANT: mandatory for sigstore
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v3
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Sign the dists with Sigstore
+      uses: sigstore/[email protected]
+      with:
+        inputs: >-
+          ./dist/*.tar.gz
+          ./dist/*.whl
+    - name: Create GitHub Release
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+      run: >-
+        gh release create
+        '${{ github.ref_name }}'
+        --repo '${{ github.repository }}'
+        --notes ""
+    - name: Upload artifact signatures to GitHub Release
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+      # Upload to GitHub Release using the `gh` CLI.
+      # `dist/` contains the built packages, and the
+      # sigstore-produced signatures and certificates.
+      run: >-
+        gh release upload
+        '${{ github.ref_name }}' dist/**
+        --repo '${{ github.repository }}'
+

.github/workflows/test.yml

@@ -35,7 +35,7 @@ jobs:
       - name: Build and export
         uses: docker/build-push-action@v5
         with:
-          file: src/templates/rpc/Dockerfile_rpc
+          file: src/warnet/templates/rpc/Dockerfile_rpc
           context: .
           tags: warnet/dev
           cache-from: type=gha
@@ -74,13 +74,13 @@ jobs:
           uv pip install -e .
 
           echo "Contents of warnet-rpc-statefulset-dev.yaml being used:"
-          cat src/templates/rpc/warnet-rpc-statefulset-dev.yaml
+          cat src/warnet/templates/rpc/warnet-rpc-statefulset-dev.yaml
 
           echo Setting up k8s
-          kubectl apply -f src/templates/rpc/namespace.yaml
-          kubectl apply -f src/templates/rpc/rbac-config.yaml
-          kubectl apply -f src/templates/rpc/warnet-rpc-service.yaml
-          kubectl apply -f src/templates/rpc/warnet-rpc-statefulset-dev.yaml
+          kubectl apply -f src/warnet/templates/rpc/namespace.yaml
+          kubectl apply -f src/warnet/templates/rpc/rbac-config.yaml
+          kubectl apply -f src/warnet/templates/rpc/warnet-rpc-service.yaml
+          kubectl apply -f src/warnet/templates/rpc/warnet-rpc-statefulset-dev.yaml
           kubectl config set-context --current --namespace=warnet
 
           echo sleeping for 30s to give k8s time to boot

.gitignore

@@ -4,3 +4,5 @@ __pycache__
 warnet.egg-info
 .python-version
 .env
+dist/
+build/

MANIFEST.in

@@ -1,9 +1,11 @@
-include src/schema/*.json
-include src/templates/bitcoin.conf
-include src/templates/fork_observer_config.toml
-include src/templates/addrman_observer_config.toml
-include src/templates/addrman.patch
-include src/templates/isroutable.patch
-graft src/templates/k8s
-graft src/templates/rpc
-graft src/templates/grafana-provisioning
+include src/warnet/schema/*.json
+include src/warnet/templates/bitcoin.conf
+include src/warnet/templates/fork_observer_config.toml
+include src/warnet/templates/addrman_observer_config.toml
+include src/warnet/templates/addrman.patch
+include src/warnet/templates/isroutable.patch
+include src/warnet/scripts/quick_start.sh
+graft src/warnet/templates/k8s
+graft src/warnet/templates/rpc
+graft src/warnet/templates/grafana-provisioning
+graft src/warnet/logging_config

README.md

@@ -15,13 +15,14 @@ Monitor and analyze the emergent behaviors of Bitcoin networks.
 
 ## Documentation
 
-- [Installation](docs/install.md)
-- [Running Warnet](docs/running.md)
-- [Network Topology](docs/graph.md)
-- [CLI Commands](docs/warcli.md)
-- [Scenarios](docs/scenarios.md)
-- [Data Collection](docs/data.md)
-- [Monitoring](docs/monitoring.md)
-- [Lightning Network](docs/lightning.md)
+- [Installation](https://github.com/bitcoin-dev-project/warnet/blob/main/docs/install.md)
+- [Quick Run](https://github.com/bitcoin-dev-project/warnet/blob/main/docs/quickrun.md)
+- [Running Warnet](https://github.com/bitcoin-dev-project/warnet/blob/main/docs/running.md)
+- [Network Topology](https://github.com/bitcoin-dev-project/warnet/blob/main/docs/graph.md)
+- [CLI Commands](https://github.com/bitcoin-dev-project/warnet/blob/main/docs/warcli.md)
+- [Scenarios](https://github.com/bitcoin-dev-project/warnet/blob/main/docs/scenarios.md)
+- [Data Collection](https://github.com/bitcoin-dev-project/warnet/blob/main/docs/data.md)
+- [Monitoring](https://github.com/bitcoin-dev-project/warnet/blob/main/docs/monitoring.md)
+- [Lightning Network](https://github.com/bitcoin-dev-project/warnet/blob/main/docs/lightning.md)
 
-![warnet-art](docs/machines.webp)
+![warnet-art](https://raw.githubusercontent.com/bitcoin-dev-project/warnet/main/docs/machines.webp)

docs/developer-notes.md

@@ -18,4 +18,4 @@ DOCKER_REGISTRY=bitcoindevproject/warnet-rpc TAG=0.1 ./scripts/build-k8s-rpc.sh
 
 You can optionally specify `LATEST=1` to also include the `latest` tag on docker hub.
 
-Once a new image has been pushed, it should be referenced in [warnet-rpc-statefulset.yaml](../src/templates/warnet-rpc-statefulset.yaml) in the `image` field.
+Once a new image has been pushed, it should be referenced in [warnet-rpc-statefulset.yaml](../src/warnet/templates/warnet-rpc-statefulset.yaml) in the `image` field.

docs/quickrun.md

@@ -0,0 +1,44 @@
+# Quick run
+
+Warnet runs a server which can be used to manage multiple networks. On docker
+this runs locally, but on Kubernetes this runs as a `statefulSet` in the
+cluster.
+
+If the `$XDG_STATE_HOME` environment variable is set, the server will log to
+a file `$XDG_STATE_HOME/warnet/warnet.log`, otherwise it will use `$HOME/.warnet/warnet.log`.
+
+## Quick start via pip
+
+You can install warnet via `pip` into your virtual environment with
+
+```bash
+python3 -m venv .venv
+source .venv/bin/activate
+pip install warnet
+```
+
+Following installation `warcli` commands will operate natively on the Kubernetes cluster currently configured with `kubectl`.
+
+Starting the Warnet server is as easy as:
+
+```bash
+# (optional) if using a local minikube cluster check that we have all required programs installed
+warcli setup
+
+# (optional) if using a local minikube cluster, set it up
+warcli cluster minikube-setup
+
+warcli cluster deploy
+```
+
+This also automatically configures port forwarding to the Server in the cluster.
+
+To tear down the cluster:
+
+```bash
+warcli cluster teardown
+
+# (optional) if using a local minikube cluster, remove the image
+warcli cluster minikube-clean
+
+

docs/release-process.md

@@ -0,0 +1,29 @@
+# Release process
+
+Once a tag is pushed to GH this will start an image build using the tag
+
+## Prerequisites
+
+- [ ] Update version in pyproject.toml
+- [ ] Tag git with new version
+- [ ] Push tag to GitHub
+
+## Manual Builds
+
+```bash
+# Install build dependencies
+pip install -e .[build]
+
+# Remove previous release metadata
+rm -i -Rf build/ dist/
+
+# Build wheel
+python3 -m build
+```
+
+### Upload
+
+```bash
+# Upload to Pypi
+python3 -m twine upload dist/*
+```

docs/running.md

@@ -9,9 +9,9 @@ a file `$XDG_STATE_HOME/warnet/warnet.log`, otherwise it will use `$HOME/.warnet
 
 ## Kubernetes
 
-Deploy the resources in `src/templates/`, this sets up the correct permissions on the cluster (`rbac-config.yaml`) and deploys the warnet RPC server as a service + statefulset.
+Deploy the resources in `src/warnet/templates/`, this sets up the correct permissions on the cluster (`rbac-config.yaml`) and deploys the warnet RPC server as a service + statefulset.
 
-This can be done with from inside the `src/templates/` directory by running:
+This can be done with from inside the `src/warnet/templates/` directory by running:
 
 ```bash
 kubectl apply -f '*.yaml'
@@ -40,13 +40,13 @@ kubectl delete statefulset
 First make sure you have `helm` installed, then simply run the following script:
 
 ```bash
-./src/templates/k8s/install_logging.sh
+./src/warnet/templates/k8s/install_logging.sh
 ```
 
 To forward port to view Grafana dashboard:
 
 ```bash
-./src/templates/k8s/connect_logging.sh
+./src/warnet/templates/k8s/connect_logging.sh
 ```
 
 ## Kubernetes (e.g. minikube)