Skip to content

Commit

Permalink
README and privacy policy
Browse files Browse the repository at this point in the history
  • Loading branch information
PrinceOfPuppers committed Dec 8, 2020
1 parent 7be3f3a commit 1154d88
Show file tree
Hide file tree
Showing 6 changed files with 78 additions and 1 deletion.
66 changes: 66 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# sync-dl-gui
> An App for downloading and syncing remote playlists to your phone
- [ABOUT](#ABOUT)
- [DEVLOPMENT](#DEVLOPMENT)

# ABOUT
Created to avoid having music deleted but still have the convenience of browsing, adding and reordering new music using remote services such as youtube.

the application does not store any of its metadata in songs, metadata is stored next to them in a .metadata file, the music files are managed through numbering, allowing them to be played alphanumerically using any playback service (such as VLC)



### Smart Sync:
The main feature of sync-dl Adds new music from remote playlist to local playlist, also takes ordering of remote playlist
without deleting songs no longer available in remote playlist.

songs that are no longer available in remote, will remain after the song they are currently after in the local playlist



# DEVLOPMENT

## On Desktop

```
git clone https://github.com/PrinceOfPuppers/sync-dl-gui
cd sync-dl-gui
pip install -r requirements.txt
python3 sync_dl_gui/main.py
```


## On Mobile
install buildozer https://buildozer.readthedocs.io/en/latest/

install adb https://developer.android.com/studio/command-line/adb

Enable developer mode on your smartphone and connect it to your computer via usb, be sure to enable usb debugging.
Test if connection is working using
```
adb devices
```

Clone the project and setup logging

```
git clone https://github.com/PrinceOfPuppers/sync-dl-gui
cd sync-dl-gui
pip install -r requirements.txt
adb logcat -s "python" > logs/logcat
```

In a seperate terminal run the following to build and push to your smartphone
```
cd PATH_TO_SYNC-DL-GUI
buildozer android debug update deploy run
```
this should build, install and launch sync-dl-gui on your phone, however at times buildozer fails to auto launch
in which case just manually open the newly installed app.
9 changes: 9 additions & 0 deletions privacy-policy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Privacy
This Applications does not collect any user data, it does however connect to youtube
through youtube-dl, please see both of their policies below:

## Youtube:
https://www.youtube.com/intl/ALL_ca/howyoutubeworks/policies/overview/

## youtube-dl:
https://github.com/ytdl-org/youtube-dl/blob/master/README.md
2 changes: 2 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
kivy
youtube-dl
Binary file removed sync_dl_gui/assets/leaves2.jpg
Binary file not shown.
Binary file removed sync_dl_gui/assets/test.jpg
Binary file not shown.
2 changes: 1 addition & 1 deletion sync_dl_gui/main.kv
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ FloatLayout:
anchor_x: 'center'
anchor_y: 'center'
Image:
source: 'assets/test.jpg'
source: 'assets/leaves1.jpg'
allow_stretch: True
keep_ratio: True
size_hint_y: None
Expand Down

0 comments on commit 1154d88

Please sign in to comment.