https://github.com/leocov-dev/odc-commander

https://github.com/leocov-dev/odc-commander

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/leocov-dev/odc-commander
• Owner: leocov-dev
• License: gpl-3.0
• Created: 2024-06-14T21:45:01.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-24T22:38:24.000Z (over 1 year ago)
• Last Synced: 2024-12-31T18:42:09.682Z (over 1 year ago)
• Language: Python
• Size: 1.72 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# ODC Commander

![GitHub Release](https://img.shields.io/github/v/release/leocov-dev/odc-commander)

![GitHub License](https://img.shields.io/github/license/leocov-dev/odc-commander)

![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/leocov-dev/odc-commander/ci.yaml)

> [!WARNING]

> 

> This is still work-in-progress and is not producing usable builds

This is a command and control app for [Open Dynamic Clamp](https://github.com/nsdesai/dynamic_clamp/tree/master/open-dynamic-clamp). 

Different versions may support different flavors of the device firmware. 

Please check the release notes for each release for supported version details.

## Install

Browse the [Releases](https://github.com/leocov-dev/odc-commander/releases) page for pre-compiled app executables.

The builds are not cryptographically signed, so you may be presented with a dialog to allow the app to run.

## Local Development

### Requirements

- [Hatch](https://hatch.pypa.io/latest/)

- Python 3.12

---

Create the default venv

```shell

hatch env create

```

Run the app

```shell

hatch run odc-commander

```

Create a local release for your operating system. 

Cross compiling to a packaged binary is not supported.

The build is placed in the `dist` directory.

```shell

hatch build -t pyside-app

```

Run linting/formatting. Will auto-format code and run formatting and type checking validations.

```shell

hatch fmt

```