Skip to content

Commit 88f750b

Browse files
ananasmoeananasmoe
committed
feat: soundcloud scraper
0 parents  commit 88f750b

File tree

7 files changed

+370
-0
lines changed

7 files changed

+370
-0
lines changed

‎.gitignore‎

Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,162 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
share/python-wheels/
24+
*.egg-info/
25+
.installed.cfg
26+
*.egg
27+
MANIFEST
28+
29+
# PyInstaller
30+
# Usually these files are written by a python script from a template
31+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
32+
*.manifest
33+
*.spec
34+
35+
# Installer logs
36+
pip-log.txt
37+
pip-delete-this-directory.txt
38+
39+
# Unit test / coverage reports
40+
htmlcov/
41+
.tox/
42+
.nox/
43+
.coverage
44+
.coverage.*
45+
.cache
46+
nosetests.xml
47+
coverage.xml
48+
*.cover
49+
*.py,cover
50+
.hypothesis/
51+
.pytest_cache/
52+
cover/
53+
54+
# Translations
55+
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
docs/_build/
73+
74+
# PyBuilder
75+
.pybuilder/
76+
target/
77+
78+
# Jupyter Notebook
79+
.ipynb_checkpoints
80+
81+
# IPython
82+
profile_default/
83+
ipython_config.py
84+
85+
# pyenv
86+
# For a library or package, you might want to ignore these files since the code is
87+
# intended to run in multiple environments; otherwise, check them in:
88+
# .python-version
89+
90+
# pipenv
91+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
93+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
94+
# install all needed dependencies.
95+
#Pipfile.lock
96+
97+
# poetry
98+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
99+
# This is especially recommended for binary packages to ensure reproducibility, and is more
100+
# commonly ignored for libraries.
101+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
102+
#poetry.lock
103+
104+
# pdm
105+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
106+
#pdm.lock
107+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
108+
# in version control.
109+
# https://pdm.fming.dev/latest/usage/project/#working-with-version-control
110+
.pdm.toml
111+
.pdm-python
112+
.pdm-build/
113+
114+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
115+
__pypackages__/
116+
117+
# Celery stuff
118+
celerybeat-schedule
119+
celerybeat.pid
120+
121+
# SageMath parsed files
122+
*.sage.py
123+
124+
# Environments
125+
.env
126+
.venv
127+
env/
128+
venv/
129+
ENV/
130+
env.bak/
131+
venv.bak/
132+
133+
# Spyder project settings
134+
.spyderproject
135+
.spyproject
136+
137+
# Rope project settings
138+
.ropeproject
139+
140+
# mkdocs documentation
141+
/site
142+
143+
# mypy
144+
.mypy_cache/
145+
.dmypy.json
146+
dmypy.json
147+
148+
# Pyre type checker
149+
.pyre/
150+
151+
# pytype static type analyzer
152+
.pytype/
153+
154+
# Cython debug symbols
155+
cython_debug/
156+
157+
# PyCharm
158+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
159+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
160+
# and can be added to the global gitignore or merged into this file. For a more nuclear
161+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
162+
#.idea/

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 mov-cli
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎Makefile‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
.PHONY: build
2+
3+
PIP = pip
4+
PYTHON = python
5+
6+
build:
7+
${PYTHON} -m build
8+
9+
install:
10+
${PIP} install . -U
11+
12+
install-editable:
13+
${PIP} install -e . --config-settings editable_mode=compat
14+
15+
test:
16+
ruff .

‎README.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
<div align="center">
2+
3+
# mov-cli-soundcloud
4+
<sub>A mov-cli v4 plugin for playing soundcloud.</sub>
5+
6+
<img src="https://github.com/mov-cli/mov-cli-soundcloud/assets/132799819/7c47b8e1-54d0-44be-abef-e3d82f5848f0">
7+
8+
9+
</div>
10+
11+
## Installation 🛠️
12+
Here's how to install and add the plugin to mov-cli.
13+
14+
1. Install the pip package.
15+
```sh
16+
pip install mov-cli-soundcloud
17+
```
18+
2. Then add the plugin to your mov-cli config.
19+
```sh
20+
mov-cli -e
21+
```
22+
```toml
23+
[mov-cli.plugins]
24+
soundcloud = "mov-cli-soundcloud"
25+
```
26+
27+
## Usage 🖱️
28+
```sh
29+
mov-cli -s soundcloud sakuro
30+
```

‎mov_cli_soundcloud/__init__.py‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
from __future__ import annotations
2+
from typing import TYPE_CHECKING
3+
4+
if TYPE_CHECKING:
5+
from mov_cli.plugins import PluginHookData
6+
7+
from .scraper import *
8+
9+
plugin: PluginHookData = {
10+
"version": 1,
11+
"package_name": "mov-cli-soundcloud",
12+
"scrapers": {
13+
"DEFAULT": SoundCloudScraper,
14+
"soundcloud": SoundCloudScraper
15+
}
16+
}
17+
18+
__version__ = "1.0.0"

‎mov_cli_soundcloud/scraper.py‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
from __future__ import annotations
2+
from typing import TYPE_CHECKING, Iterable
3+
4+
from mov_cli.config import Config
5+
from mov_cli.http_client import HTTPClient
6+
7+
if TYPE_CHECKING:
8+
from typing import Optional, Generator, Any
9+
10+
from mov_cli import Config
11+
from mov_cli.http_client import HTTPClient
12+
from mov_cli.scraper import ScraperOptionsT
13+
14+
from dataclasses import dataclass, field
15+
16+
from mov_cli import utils
17+
from mov_cli.scraper import Scraper
18+
from mov_cli import Single, Metadata, MetadataType
19+
from mov_cli import ExtraMetadata
20+
21+
import yt_dlp
22+
23+
__all__ = ("SoundCloudScraper", "SoundCloudMetadata",)
24+
25+
@dataclass
26+
class SoundCloudMetadata(Metadata):
27+
id: int
28+
info: dict = field(default = None)
29+
30+
class SoundCloudScraper(Scraper):
31+
def __init__(self, config: Config, http_client: HTTPClient, options: Optional[ScraperOptionsT] | None = None) -> None:
32+
self.base_url = "https://soundcloud.com"
33+
34+
super().__init__(config, http_client, options)
35+
36+
def search(self, query: str, limit: Optional[int]) -> Iterable[Metadata]:
37+
search_page = self.http_client.get(f"{self.base_url}/search?q={query}")
38+
39+
soup = self.soup(search_page)
40+
41+
noscript = soup.find_all("noscript")[-1]
42+
43+
items = noscript.select("h2 > a")
44+
45+
if limit is not None:
46+
items = items[:limit]
47+
48+
yt_options = {"skip_download": True, "quiet": not self.config.debug}
49+
50+
for _, item in enumerate(items):
51+
if item["href"].count("/") == 2: # NOTE: only get music
52+
with yt_dlp.YoutubeDL(yt_options) as f:
53+
info = f.extract_info(self.base_url + item["href"])
54+
55+
yield SoundCloudMetadata(
56+
id = _,
57+
title = info.get("title") + " ~ " + info.get("uploader"),
58+
type = MetadataType.SINGLE,
59+
year = info.get("upload_date", "")[:4],
60+
info = info,
61+
62+
extra_func = lambda: ExtraMetadata(
63+
description = info.get("description"),
64+
image_url = info.get("thumbnails")[-1]["url"],
65+
genres = info.get("genres")
66+
)
67+
)
68+
69+
def scrape(self, metadata: SoundCloudScraper, episode: utils.EpisodeSelector) -> Single:
70+
return Single(
71+
url = metadata.info.get("formats")[-1]["url"],
72+
title = metadata.title,
73+
year = metadata.year
74+
)

‎pyproject.toml‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
[project]
2+
name = "mov-cli-soundcloud"
3+
description = "A mov-cli plugin for playing soundcloud."
4+
authors = [
5+
{name = "r3tr0ananas", email = "[email protected]"}
6+
]
7+
readme = {file = "README.md", content-type = "text/markdown"}
8+
requires-python = ">=3.8"
9+
license = { file = "LICENSE" }
10+
keywords = [
11+
"amazing mov-cli plugin"
12+
]
13+
classifiers = [
14+
'Operating System :: Microsoft :: Windows :: Windows 11',
15+
'Operating System :: Microsoft :: Windows :: Windows 10',
16+
'Operating System :: POSIX :: Linux',
17+
'License :: OSI Approved :: MIT License',
18+
'Programming Language :: Python :: 3.8',
19+
'Programming Language :: Python :: 3.9',
20+
'Programming Language :: Python :: 3.10',
21+
'Programming Language :: Python :: 3.11',
22+
"Programming Language :: Python :: 3.12"
23+
]
24+
dependencies = [
25+
"requests",
26+
"importlib-metadata; python_version<'3.8'"
27+
]
28+
29+
dynamic = ["version"]
30+
31+
[project.optional-dependencies]
32+
dev = [
33+
"ruff",
34+
"build"
35+
]
36+
37+
[project.urls]
38+
GitHub = "https://github.com/mov-cli/mov-cli-soundcloud"
39+
BugTracker = "https://github.com/mov-cli/mov-cli-soundcloud/issues"
40+
41+
[tool.setuptools.dynamic]
42+
version = { attr = "mov_cli_soundcloud.__version__" }
43+
44+
[build-system]
45+
requires = ["setuptools"]
46+
build-backend = "setuptools.build_meta"
47+
48+
[tool.setuptools.packages.find]
49+
include = ["mov_cli_soundcloud*"]

0 commit comments

Comments
 (0)