modularize src

+ merge main.py and manage.py
+ move start logic to swingmusic/__main__.py
+ add a run.py on the project root

Author: cwilvx

.github/workflows/release.yml

@@ -107,7 +107,7 @@ jobs:
       #     python -m poetry install
       - name: Build server
         run: |
-          python main.py --build
+          python run.py --build
         env:
           SWINGMUSIC_APP_VERSION: ${{ inputs.tag }}
       - name: Rename Unix binary

Dockerfile

@@ -35,4 +35,4 @@ RUN pip install bjoern
 ARG app_version
 ENV SWINGMUSIC_APP_VERSION=$app_version
 
-ENTRYPOINT ["python", "main.py", "--host", "0.0.0.0", "--config", "/config"]
+ENTRYPOINT ["python", "run.py", "--host", "0.0.0.0", "--config", "/config"]

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Mungai Njoroge
+Copyright (c) 2025 Mungai Njoroge
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -122,12 +122,63 @@ services:
     restart: unless-stopped
 ```
 
-### Contributing
+### Contributing and Development
 
 Swing Music is looking for contributors. If you're interested, please join us at the [Swing Music Community](https://t.me/+9n61PFcgKhozZDE0) group on Telegram. For more information, take a look at https://github.com/swing-opensource/swingmusic/issues/186.
 
 [**CONTRIBUTING GUIDELINES**](.github/contributing.md).
 
+> [!TIP]
+> This project runs on Python 3.11 or newer and uses [uv](https://docs.astral.sh/uv) to manage dependencies. Please [install uv](https://docs.astral.sh/uv/getting-started/installation/) before continuing for an easy setup.
+
+To set up this project on your computer follow the following steps:
+
+```sh
+# 1. Fork the project
+
+git clone https://github.com/swingmx/swingmusic.git
+
+# or via SSH
+
+git clone git@github.com:swingmx/swingmusic.git
+```
+
+```sh
+# 2. Install dependencies
+
+uv sync
+```
+
+```sh
+# 3. Install wsgi server
+
+# If you are on Windows, install waitress:
+uv add waitress
+
+# If you are on Unix, install bjoern:
+uv add bjoern
+```
+
+> [!TIP]
+> The `libev` package is needed on Linux and MacOS. You can install it on other system as shown:
+> 
+> ```sh
+> # Arch Linux
+> pacman -S libev
+> 
+> # Fedora, CentOS
+> dnf install libev-devel
+> 
+> # MacOS
+> brew install libev
+> ```
+
+```sh
+# 4. Run the program
+
+uv run python run.py
+```
+
 ### License
 
 This software is provided to you with terms stated in the MIT License. Read the full text in the `LICENSE` file located at the root of this repository.

aarch64_buildscript

@@ -44,7 +44,7 @@ cd ../swingmusic
 # poetry install
 # Swing gives error if this is not set. Set to version of repo you cloned.
 export SWINGMUSIC_APP_VERSION="TAG"
-python main.py --build
+python run.py --build
 
 # rename binary
 mv dist/swingmusic dist/swingmusic_linux_arm64

app/serializers/__init__.py

@@ -1,6 +1,6 @@
 [project]
 name = "swingmusic"
-version = "2.0.2"
+version = "2.0.6"
 description = "Swing Music"
 readme = "README.md"
 requires-python = ">=3.11, <3.12"
@@ -31,7 +31,6 @@ dependencies = [
     "pillow>=11.1.0",
     "flask-openapi3==3.0.2",
     "rapidfuzz==3.11.0",
-    "waitress>=3.0.2",
     "pendulum>=3.0.0",
     "bjoern>=3.2.2",
 ]