ClinicianFOCUS / FreeScribe

A medical scribe capable of creating SOAP notes running Whisper and Kobold based on conversation with a patient
GNU General Public License v3.0
0 stars 0 forks source link

Automated deployment + Misc changes #2

Closed ItsSimko closed 1 month ago

ItsSimko commented 1 month ago

Description

GitHub workflow for auto deployment and misc changes

Changes Made

On push to repo with tag v..* auto builds into release sections Updated some app settings on first boot

Summary by Sourcery

Implement an automated deployment workflow using GitHub Actions for tagged releases and update application settings to include a new parameter. Add a build specification file for PyInstaller to facilitate the creation of executable files.

New Features:

Enhancements:

CI:

sourcery-ai[bot] commented 1 month ago

Reviewer's Guide by Sourcery

This pull request implements an automated deployment process using GitHub Actions and makes minor changes to the client application. The main changes include setting up a workflow for automatic builds and releases, updating default settings in the client, and adding a PyInstaller specification file.

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant GH as GitHub
    participant GA as GitHub Actions
    participant Rel as Release

    Dev->>GH: Push code with v*.*.* tag
    GH->>GA: Trigger workflow
    GA->>GA: Set up Python
    GA->>GA: Install requirements
    GA->>GA: Run PyInstaller
    GA->>Rel: Create new release
    GA->>Rel: Upload client.exe as asset

File-Level Changes

Change Details Files
Implement automated deployment workflow
  • Add GitHub Actions workflow for automatic builds on tag push
  • Set up PyInstaller to create a single executable file
  • Configure automatic release creation and asset upload
.github/workflows/release.yml
Update client application settings
  • Add 'API_style' parameter to default settings
client.py
Add PyInstaller specification file
  • Create PyInstaller spec file for building the client application
client.spec

Tips and commands #### Interacting with Sourcery - **Trigger a new review:** Comment `@sourcery-ai review` on the pull request. - **Continue discussions:** Reply directly to Sourcery's review comments. - **Generate a GitHub issue from a review comment:** Ask Sourcery to create an issue from a review comment by replying to it. #### Customizing Your Experience Access your [dashboard](https://app.sourcery.ai) to: - Enable or disable review features such as the Sourcery-generated pull request summary, the reviewer's guide, and others. - Change the review language. - Add, remove or edit custom review instructions. - Adjust other review settings. #### Getting Help - [Contact our support team](mailto:support@sourcery.ai) for questions or feedback. - Visit our [documentation](https://docs.sourcery.ai) for detailed guides and information. - Keep in touch with the Sourcery team by following us on [X/Twitter](https://x.com/SourceryAI), [LinkedIn](https://www.linkedin.com/company/sourcery-ai/) or [GitHub](https://github.com/sourcery-ai).
socket-security[bot] commented 1 month ago

New dependencies detected. Learn more about Socket for GitHub ↗︎

Package New capabilities Transitives Size Publisher
pypi/altgraph@0.17.4 environment, eval, filesystem, shell 0 185 kB ronaldoussoren
pypi/annotated-types@0.7.0 None 0 64.1 kB Zac-HD, adriangb
pypi/anyio@4.5.0 None 0 0 B
pypi/catalogue@2.0.10 environment Transitive: eval, filesystem, unsafe +2 176 kB explosion, honnibal, inesmontani
pypi/certifi@2024.8.30 filesystem 0 313 kB Lukasa
pypi/charset-normalizer@3.3.2 environment, eval, filesystem 0 762 kB Ousret
pypi/click@8.1.7 environment, eval, filesystem, network, shell Transitive: unsafe +2 1.17 MB
pypi/colorama@0.4.6 environment 0 116 kB tartley, wiggin15
pypi/dateparser@1.2.0 environment, eval, filesystem, network, unsafe Transitive: shell +105 222 MB asadurski, dangra, eljunior, ...3 more
pypi/distro@1.9.0 environment, eval, filesystem, shell 0 244 kB HorlogeSkynet, nir0s, sping
pypi/exceptiongroup@1.2.2 environment, eval, shell 0 131 kB
pypi/faker@30.0.0 None 0 0 B
pypi/filelock@3.16.1 None 0 0 B
pypi/fsspec@2024.9.0 None 0 0 B
pypi/h11@0.14.0 environment, eval, filesystem, network, shell 0 339 kB njs, pgjones
pypi/httpcore@1.0.5 environment, network 0 490 kB tomchristie
pypi/httpx@0.27.2 environment, filesystem, network, unsafe 0 864 kB florimondmanca, tomchristie, yeraydiazdiaz
pypi/idna@3.10 filesystem, network 0 1.14 MB kjd
pypi/jinja2@3.1.4 environment, eval, filesystem, unsafe 0 921 kB
pypi/jiter@0.5.0 environment, filesystem, unsafe 0 1.65 MB davidhewitt, samuelcolvin
pypi/joblib@1.4.2 environment, eval, filesystem, network, shell, unsafe 0 11.7 MB GaelVaroquaux, lesteve, ogrisel, ...1 more
pypi/llvmlite@0.43.0 environment, filesystem, shell, unsafe 0 134 MB Siu.Kwan.Lam, esc, seibert
pypi/markupsafe@2.1.5 environment, unsafe 0 143 kB
pypi/more-itertools@10.5.0 eval, filesystem, unsafe 0 589 kB bbayles, erikrose
pypi/mpmath@1.3.0 environment, eval, filesystem, network, unsafe Transitive: shell +110 224 MB fredrik
pypi/networkx@3.3 environment, eval, filesystem, shell, unsafe 0 8.61 MB MridulS, dschult, hagberg, ...2 more
pypi/nltk@3.9.1 environment, eval, filesystem, network, shell, unsafe 0 8.44 MB alvations, iliakur, purificant, ...2 more
pypi/numba@0.60.0 environment, eval, filesystem, network, shell, unsafe 0 15.1 MB Siu.Kwan.Lam, esc, seibert, ...1 more
pypi/numpy@2.0.2 environment, eval, filesystem, network, shell, unsafe 0 101 MB charlesr.harris, matthew.brett, mattip, ...2 more
pypi/openai-whisper@20240927 environment, eval, filesystem, network, shell 0 1.89 MB jongwook
pypi/openai@1.50.2 environment, eval, filesystem, shell 0 2.38 MB atty-openai, borispower, christinakim, ...13 more
pypi/packaging@24.1 environment, eval, filesystem, shell 0 2.4 MB brettcannon, dstufft, pf_moore, ...1 more
pypi/pefile@2024.8.26 environment, filesystem, network 0 353 kB ero
pypi/phonenumbers@8.13.46 None 0 0 B
pypi/pyaudio@0.2.14 environment, filesystem, unsafe 0 343 kB hubert
pypi/pydantic-core@2.23.4 None 0 0 B
pypi/pydantic@2.9.2 None 0 0 B
pypi/pyinstaller-hooks-contrib@2024.8 environment, eval, filesystem 0 622 kB Legorooj, bjones, htgoebel, ...1 more
pypi/pyinstaller@6.10.0 environment, eval, filesystem, shell 0 2.88 MB Legorooj, bwoodsend
pypi/pyperclip@1.9.0 environment, filesystem, shell 0 71.1 kB AlSweigart
pypi/python-dateutil@2.9.0 environment, eval, filesystem, shell, unsafe 0 1.08 MB dateutilbot, jarondl, pganssle, ...1 more
pypi/python-stdnum@1.20 environment, eval, filesystem, network, shell Transitive: unsafe +154 1.5 GB arthur
pypi/pytz@2024.2 None 0 0 B
pypi/pywin32-ctypes@0.2.3 environment, filesystem 0 116 kB enthought, itziakos
pypi/regex@2024.9.11 None 0 0 B
pypi/requests@2.32.3 environment, eval, filesystem, network, shell, unsafe 0 477 kB Lukasa, graffatcolmingov, nateprewitt
pypi/scikit-learn@1.5.2 None 0 0 B
pypi/scipy@1.14.1 environment, eval, filesystem, network, shell, unsafe 0 151 MB matthew.brett, pv, rgommers, ...3 more
pypi/scrubadub@2.0.1 environment, filesystem 0 185 kB Dean.Malmgren, thomasbird
pypi/six@1.16.0 environment, filesystem 0 134 kB gutworth
pypi/sniffio@1.3.1 None 0 55.6 kB
pypi/speechrecognition@3.10.4 environment, filesystem, network, shell 0 44.8 MB Anthony.Zhang, nikkie
pypi/sympy@1.13.3 environment, eval, filesystem, network, shell, unsafe 0 30.5 MB Aaron.Meurer, certik, oscarbenjamin
pypi/textblob@0.15.3 environment, filesystem, network 0 2.34 MB sloria
pypi/threadpoolctl@3.5.0 environment, eval, shell 0 156 kB jeremiedbb, ogrisel, tommoral
pypi/tiktoken@0.7.0 environment, filesystem, network 0 3.53 MB hauntsaninja
pypi/torch@2.4.1 environment, eval, filesystem, network, shell, unsafe +2 1.63 GB atalman, facebook, malfet, ...2 more
pypi/tqdm@4.66.5 environment, eval, filesystem, network, shell 0 568 kB casper.dcl, tqdm
pypi/typing-extensions@4.12.2 environment, eval, filesystem, shell, unsafe 0 422 kB JelleZijlstra, guido, hauntsaninja, ...3 more
pypi/tzdata@2024.2 filesystem 0 602 kB belopolsky, pganssle
pypi/tzlocal@5.2 environment, filesystem, network, shell Transitive: eval, unsafe +31 3.66 MB agronholm, regebro
pypi/urllib3@2.2.3 None 0 0 B

View full report↗︎

ItsSimko commented 1 month ago

Merged so I can create a build of the project in releases