commit d2c62b0108ba2925e5dd4cca774be1280bd370a0 Author: Brian Lee Date: Mon May 27 23:08:33 2024 -0700 Initialize repo for beat saber playlist tool. diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..f6f9dd2 --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +.venv +.DS_Store/ +__pycache__/ +*.pyc +*.egg-info/ +dist/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..81bd867 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# playlist helper + +## Development + +Clone the repo and install dependencies into a local virtual environment: + +```bash +pip install --upgrade pip +pip install --editable . +``` + +## Resources + +* [ScoreSaber API](https://docs.scoresaber.com/) + +## Tips + +Avoid printing covers in console. + +```shell +jq 'del(.image)' < playlist.bplist +``` diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..4bfcaa5 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,36 @@ +[build-system] +requires = ["setuptools>=65.5.0"] +build-backend = "setuptools.build_meta" + +[project] +name = "saberlist" +version = "0.0.2" +description = "Beat Saber playlist tool" +readme = "README.md" +authors = [{ name = "blee", email = "git@blee.tube" }] +license = { file = "LICENSE" } +keywords = ["reddit"] +dependencies = [ + 'build>=1.2.1', + 'requests>=2.31.0', + 'pytest>=8.1.1', + 'pyscorescaber>=1.0.10' +] +requires-python = ">=3.8.10" +classifiers = [ + "Programming Language :: Python", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "Programming Language :: Python :: Implementation :: CPython", + "Programming Language :: Python :: Implementation :: PyPy", + "Topic :: Utilities", + "License :: OSI Approved :: Apache Software License", +] + +[project.urls] +Homepage = "https://github.com/bleetube/reddit_export" + +# https://setuptools.pypa.io/en/latest/userguide/entry_point.html +[project.scripts] +reddit_export = "reddit_export.fetch:main" \ No newline at end of file diff --git a/src/saberlist/oldscript.py b/src/saberlist/oldscript.py new file mode 100755 index 0000000..8cb844d --- /dev/null +++ b/src/saberlist/oldscript.py @@ -0,0 +1,155 @@ +import base64, json +from pathlib import Path # Nice tutorial: https://realpython.com/python-pathlib/ + +# for get_json_data() +from urllib.request import Request, urlopen, urlretrieve, build_opener, install_opener + +# for ss_leaderboard_by_stars() +from time import sleep +import decimal # for rounding down + +default_leaderboard_results = 14 +difficulty_range = 0.09 # star difficulties to include in a single playlist, e.g. 7.1 to 7.19 +playlist_author = "ScoreSaber" + +# setup urllib user-agent (required for urlretrieve) +opener=build_opener() +opener.addheaders=[('User-Agent','Mozilla/5.0')] +install_opener(opener) + +difficulty_level = { + 9: 'ExpertPlus', + 7: 'Expert', + 5: 'Hard', + 3: 'Normal', + 1: 'Easy', +} + +max_pages = 100 + +def get_json_data( uri, params = {} ): + """Build an http request using custom user-agent, otherwise target site will block the request with a 403 error. + Returns a dictionary object on success.""" +# problem with params: data turns the request into a POST +# http_req = Request( uri, data=params, headers=http_headers ) +# http_req = Request( uri, headers=http_headers ) + http_req = Request( uri ) + try: + with urlopen( http_req ) as http_response: + return json.loads( http_response.read().decode() ) + except Exception as e: + print(e) + +@click.command() +@click.option('--star', type=int, + help='Star difficulty rating.') +def ss_leaderboard_by_stars( star: int ): + """Build separate playlists for every block of n.1 for a given star level""" + stars = float( star ) + ss_leaderboard = {} + + # https://docs.scoresaber.com/#/Leaderboards/get_api_leaderboards + uri = 'https://scoresaber.com/api/leaderboards' + params = { + "category": 3, # sort by scores + "sort": 1, # sort ascending + "maxStar": star + 1, + "minStar": star, + "page": 1, + "qualified": 0, + "ranked": 1, + } + ss_playlists = {} + # Configure Decimal to help us truncate a float + decimal.getcontext().rounding = decimal.ROUND_DOWN + + # sanity check: never paginate more than 100 times + while params['page'] < max_pages: + + # TODO: call get_json_data using the params dict instead of doing this ugly ass string manipulation + ss_request = "https://scoresaber.com/api/leaderboards?" + \ + f"category=3&maxStar={params['maxStar']}&minStar={params['minStar']}&qualified=0&ranked=0&sort=1&verified=1&page={params['page']}" + ss_response = get_json_data( ss_request ) + + # save results + for song in ss_response['leaderboards']: + # maxStar is necessarily one integer higher, but we don't want songs on that difficulty. + if song['stars'] == params['maxStar']: + print( f"Skipping: {song['stars']}★ [{difficulty_level[ song['difficulty']['difficulty'] ]}] : {song['songName']} by {song['songAuthorName']}") + continue + + print( f"Adding: {song['stars']}★ [{difficulty_level[ song['difficulty']['difficulty'] ]}] : {song['songName']} by {song['songAuthorName']}") + + # Group songs by rounding down to one decimal place to truncate the star difficulty. + playlist_group = round( decimal.Decimal( song['stars'] ), 1 ) + playlist_title = f"{playlist_group:.1f}" + + if playlist_title not in ss_playlists: + # initialize the playlist + ss_playlists[ playlist_title ] = [] + # add song to playlist + ss_playlists[ playlist_title ].append( song ) + + # if we got less than the typical number of results, we've reached the last page of results. + leaderboard_results = len( ss_response['leaderboards'] ) + if leaderboard_results < default_leaderboard_results: + print( f"Got {leaderboard_results} results on page {params['page']}, ending search." ) + break + + print( f"Got {leaderboard_results} songs on page {params['page']}/{max_pages}, continuing to next page in 500 milliseconds." ) + sleep(0.5) + params['page'] += 1 + + # END WHILE + + # build all the playlists + for title, playlist in ss_playlists.items(): + build_playlist( title, playlist ) + +def build_playlist(title: str, playlist: list): + """Create a new playlist file for Beat Saber.""" + # Initialize a new playlist. + # \u2605 is the unicode star emoji. + bplist = { 'playlistTitle': f"Ranked {title}\u2605", + 'playlistAuthor': playlist_author, + 'playlistDescription': 'Automatically generated playlist', + 'songs': [], + 'image': "" + } + for song in playlist: + bplist['songs'].append({ + 'key': song['id'], + 'hash': song['songHash'], + 'name': song['songName'], + 'uploader': song['songAuthorName'], + 'difficulties': [ + { + 'characteristic': "Standard", + 'name': difficulty_level[ song['difficulty']['difficulty'] ] + } + ] + }) + # check for cover art and add it + coverart_path = Path.cwd() / "coverart" / f"{title}.jpg" + if coverart_path.is_file(): + with open( coverart_path, 'rb') as cover: + cover_data = base64.b64encode(cover.read()).decode() + bplist["image"] = f"base64,{cover_data}" + print( "INFO: Cover art was added.") + else: + print( "NOTICE: Cover art not found, skipping.") + + # create a subdir named "playlists" if it doesn't already exist + playlist_path = Path.cwd() / "playlists" + playlist_path.mkdir( exist_ok = True ) + playlist_file = Path( playlist_path / f"{title}.bplist" ) + try: + with open(playlist_file, "w") as playlist: + playlist.write( json.dumps( bplist )) + print( f"INFO: Created new playlist: {title}.bplist" ) + except Exception as e: + print(f"ERROR: Failed to create playlist: {playlist_file}") + print(e) + +if __name__ == '__main__': + ss_leaderboard_by_stars() diff --git a/src/saberlist/scoresaber.py b/src/saberlist/scoresaber.py new file mode 100644 index 0000000..1becc06 --- /dev/null +++ b/src/saberlist/scoresaber.py @@ -0,0 +1,91 @@ +import json +import asyncio +from pyscoresaber import ScoreSaberAPI, ScoreSort + +blee_id = '76561199407393962' +isuldor_id = '76561197962107242' + +async def show_player(player_id): + async with ScoreSaberAPI() as scoresaber: + return await scoresaber.player_full(player_id) + +async def get_all_player_scores(scoresaber: ScoreSaberAPI, player_id: int, score_sort: ScoreSort): + all_scores = [] + async for player_scores in scoresaber.player_scores_all(player_id, score_sort): + all_scores.extend(player_scores) + return all_scores + +def filter_and_sort_scores_by_stars(scores, min_stars=0.1, max_stars=float('inf')): + # Exclude scores outside the specified star range + filtered_scores = [score for score in scores if min_stars <= score.leaderboard.stars < max_stars] + # Sort the remaining scores by stars + sorted_scores = sorted(filtered_scores, key=lambda x: x.leaderboard.stars) + return sorted_scores + +def scores_to_playlist(scores, playlist_title, playlist_author, filename): + playlist = { + "playlistTitle": playlist_title, + "playlistAuthor": playlist_author, + "songs": [] + } + + for score in scores: + song_entry = { + "hash": score.leaderboard.song_hash, + "songName": score.leaderboard.song_name, + "difficulties": [ + { + "name": score.leaderboard.difficulty.difficulty.name.lower(), + "characteristic": score.leaderboard.difficulty.game_mode.value + } + ], + "levelAuthorName": score.leaderboard.level_author_name + } + playlist["songs"].append(song_entry) + + playlist_json = json.dumps(playlist) + + with open(filename, 'w') as file: + file.write(playlist_json) + +def scores_to_playlist(scores, playlist_title, playlist_author, filename): + playlist = { + "playlistTitle": playlist_title, + "playlistAuthor": playlist_author, + "songs": [] + } + + for score in scores: + song_entry = { + "hash": score.leaderboard.song_hash, + "songName": score.leaderboard.song_name, + "difficulties": [ + { + "name": score.leaderboard.difficulty.difficulty.name.lower(), + "characteristic": score.leaderboard.difficulty.game_mode.name.lower() + } + ], + "levelAuthorName": score.leaderboard.level_author_name + } + playlist["songs"].append(song_entry) + + + playlist_json = json.dumps(playlist, indent=4) + with open(filename, 'w') as file: + file.write(playlist_json) + + return playlist_json + +async def build_playlists(player_id): + async with ScoreSaberAPI() as api: + scores = await get_all_player_scores(api, player_id, ScoreSort.TOP) + return scores + + scores = asyncio.run(build_playlists(blee_id)) + + filtered_sorted_scores = filter_and_sort_scores_by_stars(scores, min_stars=2, max_stars=3) + scores_to_playlist(filtered_sorted_scores, "Played SS TWO\u2605", "ScoreSaber", "Played SS TWO.bplist") + filtered_sorted_scores = filter_and_sort_scores_by_stars(scores, min_stars=3, max_stars=4) + scores_to_playlist(filtered_sorted_scores, "Played SS THREE\u2605", "ScoreSaber", "Played SS THREE.bplist") + filtered_sorted_scores = filter_and_sort_scores_by_stars(scores, min_stars=4, max_stars=5) + scores_to_playlist(filtered_sorted_scores, "Played SS FOUR\u2605", "ScoreSaber", "Played SS FOUR.bplist")