scrobbles 0.1.0__tar.gz

scrobbles-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,32 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+      - run: uv version "${GITHUB_REF_NAME#v}"
+      - run: uv build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: astral-sh/setup-uv@v6
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - run: uv publish dist/*

scrobbles-0.1.0/.gitignore

@@ -0,0 +1,213 @@
+# Claude Code
+.claude/
+
+# User data
+data/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

scrobbles-0.1.0/.python-version

@@ -0,0 +1 @@
+3.14

scrobbles-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Sam Foreman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

scrobbles-0.1.0/PKG-INFO

@@ -0,0 +1,175 @@
+Metadata-Version: 2.4
+Name: scrobbles
+Version: 0.1.0
+Summary: Fetch, export, and visualize Last.fm listening data — plus create Spotify playlists from your top albums
+Project-URL: Homepage, https://github.com/saforem2/scrobbles
+Project-URL: Repository, https://github.com/saforem2/scrobbles
+Project-URL: Issues, https://github.com/saforem2/scrobbles/issues
+Author-email: Sam Foreman <saforem2@gmail.com>
+License: MIT
+License-File: LICENSE
+Keywords: audioscrobbler,last.fm,lastfm,music,scrobble,spotify
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Multimedia :: Sound/Audio
+Requires-Python: >=3.12
+Requires-Dist: pylast>=7.0.2
+Requires-Dist: spotipy>=2.26.0
+Description-Content-Type: text/markdown
+
+# scrobbles
+
+Fetch, export, and visualize [Last.fm](https://www.last.fm/) listening data — plus create Spotify playlists from your top albums.
+
+## Setup
+
+### Prerequisites
+
+- Python 3.12+
+- [uv](https://docs.astral.sh/uv/) (recommended) or pip
+
+### Install
+
+```bash
+pip install scrobbles
+# or
+uv add scrobbles
+```
+
+#### From source
+
+```bash
+git clone https://github.com/saforem2/scrobbles.git
+cd lastfm
+uv sync
+```
+
+### Environment Variables
+
+#### Last.fm
+
+Get API credentials at <https://www.last.fm/api/account>.
+
+```bash
+export LASTFM_API_KEY="..."
+export LASTFM_API_SECRET="..."
+export LASTFM_USERNAME="..."
+export LASTFM_PASSWORD="..."
+```
+
+#### Spotify (optional — only needed for playlist creation)
+
+1. Create an app at <https://developer.spotify.com/dashboard>
+2. Add `http://127.0.0.1:8888/callback` as a Redirect URI in your app settings
+3. Export your credentials:
+
+```bash
+export SPOTIFY_CLIENT_ID="..."       # or SPOTIPY_CLIENT_ID
+export SPOTIFY_CLIENT_SECRET="..."   # or SPOTIPY_CLIENT_SECRET
+export SPOTIPY_REDIRECT_URI="http://127.0.0.1:8888/callback"
+```
+
+Either `SPOTIFY_*` or `SPOTIPY_*` naming works — the library maps them automatically.
+
+## Usage
+
+### CLI
+
+```bash
+# Via entry point (after install)
+scrobbles top-albums overall --limit 25
+scrobbles top-albums 2024
+scrobbles dashboard
+
+# Via main.py (development)
+uv run python main.py top-albums overall --limit 25
+uv run python main.py top-albums 2024
+uv run python main.py top-albums last_month
+
+# Export top albums to JSON
+uv run python main.py dump-albums 2024 --limit 100
+
+# Generate the HTML dashboard from existing JSON files
+uv run python main.py dashboard
+
+# Create Spotify playlists from all top100-YYYY.json files
+uv run python main.py spotify-playlists --dry-run
+uv run python main.py spotify-playlists --skip 2020 2021
+```
+
+### Python API
+
+```python
+import scrobbles
+
+# Recent tracks & now playing
+scrobbles.get_recent_tracks("username", 10)
+print(scrobbles.get_now_playing("username"))
+
+# Top albums — predefined periods
+scrobbles.print_top_albums("username", period="7day", limit=20)
+
+# Top albums — arbitrary date ranges
+scrobbles.print_top_albums("username", period="2024")       # full year
+scrobbles.print_top_albums("username", period="2024-06")    # single month
+scrobbles.print_top_albums("username", period="last_week")
+
+# Export to JSON
+scrobbles.dump_top_albums("username", period="2024", limit=100)
+
+# Generate interactive HTML dashboard
+from scrobbles.albums import build_dashboard
+build_dashboard()  # reads data/albums/top100-*.json → data/albums/index.html
+
+# Spotify: create a playlist from any album list
+from scrobbles.spotify import create_playlist_from_albums
+albums = [{"artist": "Radiohead", "album": "OK Computer", "plays": 50}]
+create_playlist_from_albums(albums, "My Playlist", dry_run=True)
+
+# Spotify: bulk-create yearly playlists
+from scrobbles.spotify import create_all_playlists
+create_all_playlists(dry_run=True)
+```
+
+### Supported Period Strings
+
+| Period | Description |
+|---|---|
+| `overall` | All time |
+| `7day`, `1month`, `3month`, `6month`, `12month` | Rolling windows |
+| `today`, `yesterday`, `last_week`, `last_month`, `last_year` | Calendar-relative |
+| `2024` | Full calendar year |
+| `2024-06` | Single month |
+| `2024-06-15` | Single day |
+
+## Project Structure
+
+```
+lastfm/
+├── src/scrobbles/
+│   ├── __init__.py      # Network setup, track utils, re-exports
+│   ├── albums.py        # Top albums: fetch, format, export, dashboard
+│   ├── cli.py           # CLI entry point
+│   └── spotify.py       # Spotify playlist creation
+├── data/albums/         # Generated JSON + HTML dashboard
+│   ├── top100-YYYY.json
+│   └── index.html
+├── main.py              # Thin shim (calls scrobbles.cli:main)
+├── pyproject.toml
+└── README.md
+```
+
+## Publishing
+
+```bash
+# Bump version
+uv version --bump patch
+
+# Build
+uv build
+
+# Publish to PyPI
+uv publish
+```

scrobbles-0.1.0/README.md

@@ -0,0 +1,154 @@
+# scrobbles
+
+Fetch, export, and visualize [Last.fm](https://www.last.fm/) listening data — plus create Spotify playlists from your top albums.
+
+## Setup
+
+### Prerequisites
+
+- Python 3.12+
+- [uv](https://docs.astral.sh/uv/) (recommended) or pip
+
+### Install
+
+```bash
+pip install scrobbles
+# or
+uv add scrobbles
+```
+
+#### From source
+
+```bash
+git clone https://github.com/saforem2/scrobbles.git
+cd lastfm
+uv sync
+```
+
+### Environment Variables
+
+#### Last.fm
+
+Get API credentials at <https://www.last.fm/api/account>.
+
+```bash
+export LASTFM_API_KEY="..."
+export LASTFM_API_SECRET="..."
+export LASTFM_USERNAME="..."
+export LASTFM_PASSWORD="..."
+```
+
+#### Spotify (optional — only needed for playlist creation)
+
+1. Create an app at <https://developer.spotify.com/dashboard>
+2. Add `http://127.0.0.1:8888/callback` as a Redirect URI in your app settings
+3. Export your credentials:
+
+```bash
+export SPOTIFY_CLIENT_ID="..."       # or SPOTIPY_CLIENT_ID
+export SPOTIFY_CLIENT_SECRET="..."   # or SPOTIPY_CLIENT_SECRET
+export SPOTIPY_REDIRECT_URI="http://127.0.0.1:8888/callback"
+```
+
+Either `SPOTIFY_*` or `SPOTIPY_*` naming works — the library maps them automatically.
+
+## Usage
+
+### CLI
+
+```bash
+# Via entry point (after install)
+scrobbles top-albums overall --limit 25
+scrobbles top-albums 2024
+scrobbles dashboard
+
+# Via main.py (development)
+uv run python main.py top-albums overall --limit 25
+uv run python main.py top-albums 2024
+uv run python main.py top-albums last_month
+
+# Export top albums to JSON
+uv run python main.py dump-albums 2024 --limit 100
+
+# Generate the HTML dashboard from existing JSON files
+uv run python main.py dashboard
+
+# Create Spotify playlists from all top100-YYYY.json files
+uv run python main.py spotify-playlists --dry-run
+uv run python main.py spotify-playlists --skip 2020 2021
+```
+
+### Python API
+
+```python
+import scrobbles
+
+# Recent tracks & now playing
+scrobbles.get_recent_tracks("username", 10)
+print(scrobbles.get_now_playing("username"))
+
+# Top albums — predefined periods
+scrobbles.print_top_albums("username", period="7day", limit=20)
+
+# Top albums — arbitrary date ranges
+scrobbles.print_top_albums("username", period="2024")       # full year
+scrobbles.print_top_albums("username", period="2024-06")    # single month
+scrobbles.print_top_albums("username", period="last_week")
+
+# Export to JSON
+scrobbles.dump_top_albums("username", period="2024", limit=100)
+
+# Generate interactive HTML dashboard
+from scrobbles.albums import build_dashboard
+build_dashboard()  # reads data/albums/top100-*.json → data/albums/index.html
+
+# Spotify: create a playlist from any album list
+from scrobbles.spotify import create_playlist_from_albums
+albums = [{"artist": "Radiohead", "album": "OK Computer", "plays": 50}]
+create_playlist_from_albums(albums, "My Playlist", dry_run=True)
+
+# Spotify: bulk-create yearly playlists
+from scrobbles.spotify import create_all_playlists
+create_all_playlists(dry_run=True)
+```
+
+### Supported Period Strings
+
+| Period | Description |
+|---|---|
+| `overall` | All time |
+| `7day`, `1month`, `3month`, `6month`, `12month` | Rolling windows |
+| `today`, `yesterday`, `last_week`, `last_month`, `last_year` | Calendar-relative |
+| `2024` | Full calendar year |
+| `2024-06` | Single month |
+| `2024-06-15` | Single day |
+
+## Project Structure
+
+```
+lastfm/
+├── src/scrobbles/
+│   ├── __init__.py      # Network setup, track utils, re-exports
+│   ├── albums.py        # Top albums: fetch, format, export, dashboard
+│   ├── cli.py           # CLI entry point
+│   └── spotify.py       # Spotify playlist creation
+├── data/albums/         # Generated JSON + HTML dashboard
+│   ├── top100-YYYY.json
+│   └── index.html
+├── main.py              # Thin shim (calls scrobbles.cli:main)
+├── pyproject.toml
+└── README.md
+```
+
+## Publishing
+
+```bash
+# Bump version
+uv version --bump patch
+
+# Build
+uv build
+
+# Publish to PyPI
+uv publish
+```

scrobbles-0.1.0/main.py

@@ -0,0 +1,4 @@
+from scrobbles.cli import main
+
+if __name__ == "__main__":
+    main()

scrobbles-0.1.0/pyproject.toml

@@ -0,0 +1,40 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "scrobbles"
+version = "0.1.0"
+description = "Fetch, export, and visualize Last.fm listening data — plus create Spotify playlists from your top albums"
+readme = "README.md"
+requires-python = ">=3.12"
+license = { text = "MIT" }
+authors = [{ name = "Sam Foreman", email = "saforem2@gmail.com" }]
+keywords = ["lastfm", "last.fm", "scrobble", "spotify", "music", "audioscrobbler"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Topic :: Multimedia :: Sound/Audio",
+]
+dependencies = [
+    "pylast>=7.0.2",
+    "spotipy>=2.26.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/saforem2/scrobbles"
+Repository = "https://github.com/saforem2/scrobbles"
+Issues = "https://github.com/saforem2/scrobbles/issues"
+
+[project.scripts]
+scrobbles = "scrobbles.cli:main"
+
+[dependency-groups]
+dev = [
+    "bpython>=0.26",
+    "ptipython>=1.0.1",
+    "pyright>=1.1.408",
+    "ruff>=0.15.6",
+]