2 Commits

2 changed files with 20 additions and 8 deletions

View File

@@ -28,7 +28,18 @@ pipx install simple-recorder
*with pyz* *with pyz*
An executable pyz has been included in [Releases](https://github.com/onyx-and-iris/simple-recorder/releases) which you can run in Windows. Follow the steps in this [Setting up Windows for Zipapps](https://jhermann.github.io/blog/python/deployment/2020/02/29/python_zippapps_on_windows.html#Setting-Up-Windows-10-for-Zipapps) guide. - Download the pyz file in [Releases](https://github.com/onyx-and-iris/simple-recorder/releases)
- Optional step: for automatic discovery of the pyz file follow this guide on [Setting Up Windows for Zippapps](https://jhermann.github.io/blog/python/deployment/2020/02/29/python_zippapps_on_windows.html#Setting-Up-Windows-10-for-Zipapps)
Finally run the pyz with python (CLI)/pythonw (GUI):
```console
python simple-recorder.pyz <subcommand>
pythonw simple-recorder.pyz
```
note, the pyz extension won't be required if you followed the optional step and made it discoverable.
## Configuration ## Configuration
@@ -51,7 +62,7 @@ OBS_THEME=Reds
### CLI ### CLI
To launch the CLI pass any subcommand, for example: To launch the CLI:
```console ```console
simple-recorder start "File Name" simple-recorder start "File Name"
@@ -83,10 +94,10 @@ Usage: simple-recorder [OPTIONS] COMMAND
### GUI ### GUI
To launch the GUI run the root command without any subcommands: To launch the GUI:
```console ```console
simple-recorder simple-recorder-gui
``` ```
![simple-recorder](./img/simple-recorder.png) ![simple-recorder](./img/simple-recorder.png)

View File

@@ -1,6 +1,6 @@
[project] [project]
name = "simple-recorder" name = "simple-recorder"
version = "0.3.3" version = "0.3.4"
description = "A simple OBS recorder" description = "A simple OBS recorder"
authors = [{ name = "onyx-and-iris", email = "code@onyxandiris.online" }] authors = [{ name = "onyx-and-iris", email = "code@onyxandiris.online" }]
dependencies = [ dependencies = [
@@ -15,6 +15,9 @@ license = { text = "MIT" }
[project.scripts] [project.scripts]
simple-recorder = "simple_recorder:run" simple-recorder = "simple_recorder:run"
[project.gui-scripts]
simple-recorder-gui = "simple_recorder:run"
[build-system] [build-system]
requires = ["pdm-backend"] requires = ["pdm-backend"]
build-backend = "pdm.backend" build-backend = "pdm.backend"
@@ -28,6 +31,4 @@ compile = "shiv -c simple-recorder -o bin/simple-recorder.pyz ."
[dependency-groups] [dependency-groups]
build = [ build = ["shiv>=1.0.8"]
"shiv>=1.0.8",
]