trackparse 0.3.2__tar.gz → 0.3.3__tar.gz

{trackparse-0.3.2 → trackparse-0.3.3}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.5
 Name: trackparse
-Version: 0.3.2
+Version: 0.3.3
 Summary: Spec-driven parser for music track titles and tracklists: artists, feat, remixes, versions, junk, positions, times.
 Project-URL: Homepage, https://4matic.github.io/trackparse/
-Project-URL: Documentation, https://4matic.github.io/trackparse/guides/python/
+Project-URL: Documentation, https://4matic.github.io/trackparse/start/getting-started/
 Project-URL: Repository, https://github.com/4matic/trackparse
 Project-URL: Issues, https://github.com/4matic/trackparse/issues
 Project-URL: Changelog, https://github.com/4matic/trackparse/blob/main/python/CHANGELOG.md
@@ -38,7 +38,7 @@ Description-Content-Type: text/markdown
 [![python](https://img.shields.io/github/actions/workflow/status/4matic/trackparse/python.yml?branch=main&label=tests&logo=github)](https://github.com/4matic/trackparse/actions/workflows/python.yml)
 [![license](https://img.shields.io/badge/license-MIT-blue)](https://github.com/4matic/trackparse/blob/main/LICENSE)
 
-**[Documentation](https://4matic.github.io/trackparse/)** · **[Python guide](https://4matic.github.io/trackparse/guides/python/)** · **[Playground](https://4matic.github.io/trackparse/playground/)**
+**[Documentation](https://4matic.github.io/trackparse/)** · **[Getting started](https://4matic.github.io/trackparse/start/getting-started/)** · **[Playground](https://4matic.github.io/trackparse/playground/)**
 
 **Turn messy track names into structured data: who made it, who's featured, who remixed it, and
 what's just noise.**
@@ -72,6 +72,8 @@ uv add trackparse
 
 ## Quick start
 
+**Docs:** [Getting started](https://4matic.github.io/trackparse/start/getting-started/)
+
 ```python
 from trackparse import format_track, parse
 
@@ -143,6 +145,8 @@ print(json.dumps(track.to_dict(), indent=2))
 
 ## API
 
+**Docs:** [Other functions](https://4matic.github.io/trackparse/reference/functions/)
+
 ```python
 parse(input, *, mode="auto", uploader=None, known_artists=(), split_and="auto", keywords=None) -> ParsedTrack
 parse_artists(input, *, <same options>) -> list[Artist]
@@ -156,6 +160,8 @@ SPEC_VERSION, __version__
 
 ### `parse(input, **options)`
 
+**Docs:** [parse and ParsedTrack](https://4matic.github.io/trackparse/reference/parse/) · [Options](https://4matic.github.io/trackparse/reference/options/)
+
 | Option | Default | |
 |---|---|---|
 | `mode` | `"auto"` | `"clean"`, `"youtube"`, `"filename"`, `"tracklist"`, or `"auto"` to detect from the string |
@@ -196,6 +202,8 @@ the defaults. Passing something that isn't a `str` raises `TypeError`.
 
 ### `ParsedTrack`
 
+**Docs:** [ParsedTrack fields](https://4matic.github.io/trackparse/reference/parse/#parsedtrack)
+
 | Attribute | Type | |
 |---|---|---|
 | `input` | `str` | The original string, untouched |
@@ -238,6 +246,8 @@ Version types, junk kinds and warnings are listed in the
 
 ### `to_dict()` and `from_dict()`
 
+**Docs:** [JSON and Python objects](https://4matic.github.io/trackparse/reference/parse/#json-and-python-objects)
+
 Every result class has `to_dict()`, which returns plain dicts and lists matching
 [`parsed-track.schema.json`](https://github.com/4matic/trackparse/blob/main/spec/schema/parsed-track.schema.json)
 (`fullTitle`, `unknownArtist`, ...). With `json.dumps(track.to_dict(), separators=(",", ":"),
@@ -250,6 +260,8 @@ ParsedTrack.from_dict(track.to_dict()) == track  # True
 
 ### `parse_artists(input, **options)`
 
+**Docs:** [parseArtists](https://4matic.github.io/trackparse/reference/functions/#parseartistsinput-options)
+
 Splits a bare artist string. Takes the same options as `parse`.
 
 ```python
@@ -261,6 +273,8 @@ from trackparse import parse_artists
 
 ### `format_track(track, **options)`
 
+**Docs:** [format](https://4matic.github.io/trackparse/reference/functions/#formattrack-options) · [Formatting](https://4matic.github.io/trackparse/guides/formatting/)
+
 Renders a track back to a string.
 
 | Option | Default | |
@@ -290,6 +304,8 @@ format_track(track, position=True)
 
 ### `normalize(s)`
 
+**Docs:** [normalize](https://4matic.github.io/trackparse/reference/functions/#normalizeinput)
+
 The Unicode cleanup every function runs first: NFC, invisible characters, and dash, bracket and
 quote variants.
 
@@ -302,6 +318,8 @@ normalize("Noisia​ – Stigma （VIP）")
 
 ### `all_artists(track)`
 
+**Docs:** [allArtists](https://4matic.github.io/trackparse/reference/functions/#allartiststrack)
+
 Credits plus every remixer, deduplicated.
 
 ```python
@@ -313,6 +331,8 @@ from trackparse import all_artists
 
 ### `create_parser(**options)`
 
+**Docs:** [createParser](https://4matic.github.io/trackparse/reference/functions/#createparseroptions)
+
 Compiles the options once, for many calls. Per-call options are merged over the parser's: a value
 passed per call replaces the base one (`known_artists` included), `None` leaves it alone, and
 `keywords` dicts are merged.
@@ -335,6 +355,8 @@ released together and always share one version number.
 
 ## Modes
 
+**Docs:** [Modes](https://4matic.github.io/trackparse/guides/modes/)
+
 | Mode | For | Adds |
 |---|---|---|
 | `clean` | Store metadata, tags | Only a spaced dash separates artist and title |
@@ -358,6 +380,8 @@ parse("Shelter", mode="youtube", uploader="Porter Robinson").artists
 
 ## Tracklists
 
+**Docs:** [Tracklists](https://4matic.github.io/trackparse/guides/tracklists/) · [Editing tracklists](https://4matic.github.io/trackparse/guides/editing-tracklists/)
+
 `trackparse.tracklist` parses a whole tracklist, one entry per line, and checks it. Each entry
 keeps its line exactly as written plus its own line ending, so `"".join(e.raw + e.eol for e in
 tl.entries)` is always the input, CRLF or not.
@@ -467,6 +491,8 @@ parse("Electrosoul System - Liquid Metal", mode="tracklist").title
 
 ## Typing
 
+**Docs:** [Types](https://4matic.github.io/trackparse/reference/parse/#types)
+
 The package ships `py.typed` and passes `mypy --strict`. `ParsedTrack`, `Artist`, `Version`,
 `Junk`, `Flags`, `Position` and `Timestamp` are frozen dataclasses with snake_case attributes, and
 so are the tracklist results in `trackparse.tracklist`.
@@ -495,7 +521,7 @@ same spec rule IDs. Behaviour changes start in the spec, not here: see
 
 ## Links
 
-- [Documentation](https://4matic.github.io/trackparse/), with a [Python guide](https://4matic.github.io/trackparse/guides/python/) and a
+- [Documentation](https://4matic.github.io/trackparse/), with every example in Python and JavaScript, and a
   [playground](https://4matic.github.io/trackparse/playground/) that runs the parser in your browser
 - [Spec](https://github.com/4matic/trackparse/blob/main/spec/SPEC.md)
 - [Project README](https://github.com/4matic/trackparse#readme)

{trackparse-0.3.2 → trackparse-0.3.3}/README.md

@@ -5,7 +5,7 @@
 [![python](https://img.shields.io/github/actions/workflow/status/4matic/trackparse/python.yml?branch=main&label=tests&logo=github)](https://github.com/4matic/trackparse/actions/workflows/python.yml)
 [![license](https://img.shields.io/badge/license-MIT-blue)](https://github.com/4matic/trackparse/blob/main/LICENSE)
 
-**[Documentation](https://4matic.github.io/trackparse/)** · **[Python guide](https://4matic.github.io/trackparse/guides/python/)** · **[Playground](https://4matic.github.io/trackparse/playground/)**
+**[Documentation](https://4matic.github.io/trackparse/)** · **[Getting started](https://4matic.github.io/trackparse/start/getting-started/)** · **[Playground](https://4matic.github.io/trackparse/playground/)**
 
 **Turn messy track names into structured data: who made it, who's featured, who remixed it, and
 what's just noise.**
@@ -39,6 +39,8 @@ uv add trackparse
 
 ## Quick start
 
+**Docs:** [Getting started](https://4matic.github.io/trackparse/start/getting-started/)
+
 ```python
 from trackparse import format_track, parse
 
@@ -110,6 +112,8 @@ print(json.dumps(track.to_dict(), indent=2))
 
 ## API
 
+**Docs:** [Other functions](https://4matic.github.io/trackparse/reference/functions/)
+
 ```python
 parse(input, *, mode="auto", uploader=None, known_artists=(), split_and="auto", keywords=None) -> ParsedTrack
 parse_artists(input, *, <same options>) -> list[Artist]
@@ -123,6 +127,8 @@ SPEC_VERSION, __version__
 
 ### `parse(input, **options)`
 
+**Docs:** [parse and ParsedTrack](https://4matic.github.io/trackparse/reference/parse/) · [Options](https://4matic.github.io/trackparse/reference/options/)
+
 | Option | Default | |
 |---|---|---|
 | `mode` | `"auto"` | `"clean"`, `"youtube"`, `"filename"`, `"tracklist"`, or `"auto"` to detect from the string |
@@ -163,6 +169,8 @@ the defaults. Passing something that isn't a `str` raises `TypeError`.
 
 ### `ParsedTrack`
 
+**Docs:** [ParsedTrack fields](https://4matic.github.io/trackparse/reference/parse/#parsedtrack)
+
 | Attribute | Type | |
 |---|---|---|
 | `input` | `str` | The original string, untouched |
@@ -205,6 +213,8 @@ Version types, junk kinds and warnings are listed in the
 
 ### `to_dict()` and `from_dict()`
 
+**Docs:** [JSON and Python objects](https://4matic.github.io/trackparse/reference/parse/#json-and-python-objects)
+
 Every result class has `to_dict()`, which returns plain dicts and lists matching
 [`parsed-track.schema.json`](https://github.com/4matic/trackparse/blob/main/spec/schema/parsed-track.schema.json)
 (`fullTitle`, `unknownArtist`, ...). With `json.dumps(track.to_dict(), separators=(",", ":"),
@@ -217,6 +227,8 @@ ParsedTrack.from_dict(track.to_dict()) == track  # True
 
 ### `parse_artists(input, **options)`
 
+**Docs:** [parseArtists](https://4matic.github.io/trackparse/reference/functions/#parseartistsinput-options)
+
 Splits a bare artist string. Takes the same options as `parse`.
 
 ```python
@@ -228,6 +240,8 @@ from trackparse import parse_artists
 
 ### `format_track(track, **options)`
 
+**Docs:** [format](https://4matic.github.io/trackparse/reference/functions/#formattrack-options) · [Formatting](https://4matic.github.io/trackparse/guides/formatting/)
+
 Renders a track back to a string.
 
 | Option | Default | |
@@ -257,6 +271,8 @@ format_track(track, position=True)
 
 ### `normalize(s)`
 
+**Docs:** [normalize](https://4matic.github.io/trackparse/reference/functions/#normalizeinput)
+
 The Unicode cleanup every function runs first: NFC, invisible characters, and dash, bracket and
 quote variants.
 
@@ -269,6 +285,8 @@ normalize("Noisia​ – Stigma （VIP）")
 
 ### `all_artists(track)`
 
+**Docs:** [allArtists](https://4matic.github.io/trackparse/reference/functions/#allartiststrack)
+
 Credits plus every remixer, deduplicated.
 
 ```python
@@ -280,6 +298,8 @@ from trackparse import all_artists
 
 ### `create_parser(**options)`
 
+**Docs:** [createParser](https://4matic.github.io/trackparse/reference/functions/#createparseroptions)
+
 Compiles the options once, for many calls. Per-call options are merged over the parser's: a value
 passed per call replaces the base one (`known_artists` included), `None` leaves it alone, and
 `keywords` dicts are merged.
@@ -302,6 +322,8 @@ released together and always share one version number.
 
 ## Modes
 
+**Docs:** [Modes](https://4matic.github.io/trackparse/guides/modes/)
+
 | Mode | For | Adds |
 |---|---|---|
 | `clean` | Store metadata, tags | Only a spaced dash separates artist and title |
@@ -325,6 +347,8 @@ parse("Shelter", mode="youtube", uploader="Porter Robinson").artists
 
 ## Tracklists
 
+**Docs:** [Tracklists](https://4matic.github.io/trackparse/guides/tracklists/) · [Editing tracklists](https://4matic.github.io/trackparse/guides/editing-tracklists/)
+
 `trackparse.tracklist` parses a whole tracklist, one entry per line, and checks it. Each entry
 keeps its line exactly as written plus its own line ending, so `"".join(e.raw + e.eol for e in
 tl.entries)` is always the input, CRLF or not.
@@ -434,6 +458,8 @@ parse("Electrosoul System - Liquid Metal", mode="tracklist").title
 
 ## Typing
 
+**Docs:** [Types](https://4matic.github.io/trackparse/reference/parse/#types)
+
 The package ships `py.typed` and passes `mypy --strict`. `ParsedTrack`, `Artist`, `Version`,
 `Junk`, `Flags`, `Position` and `Timestamp` are frozen dataclasses with snake_case attributes, and
 so are the tracklist results in `trackparse.tracklist`.
@@ -462,7 +488,7 @@ same spec rule IDs. Behaviour changes start in the spec, not here: see
 
 ## Links
 
-- [Documentation](https://4matic.github.io/trackparse/), with a [Python guide](https://4matic.github.io/trackparse/guides/python/) and a
+- [Documentation](https://4matic.github.io/trackparse/), with every example in Python and JavaScript, and a
   [playground](https://4matic.github.io/trackparse/playground/) that runs the parser in your browser
 - [Spec](https://github.com/4matic/trackparse/blob/main/spec/SPEC.md)
 - [Project README](https://github.com/4matic/trackparse#readme)

{trackparse-0.3.2 → trackparse-0.3.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "trackparse"
-version = "0.3.2"
+version = "0.3.3"
 description = "Spec-driven parser for music track titles and tracklists: artists, feat, remixes, versions, junk, positions, times."
 readme = "README.md"
 requires-python = ">=3.9"
@@ -45,7 +45,7 @@ dependencies = []
 
 [project.urls]
 Homepage = "https://4matic.github.io/trackparse/"
-Documentation = "https://4matic.github.io/trackparse/guides/python/"
+Documentation = "https://4matic.github.io/trackparse/start/getting-started/"
 Repository = "https://github.com/4matic/trackparse"
 Issues = "https://github.com/4matic/trackparse/issues"
 Changelog = "https://github.com/4matic/trackparse/blob/main/python/CHANGELOG.md"

{trackparse-0.3.2 → trackparse-0.3.3}/src/trackparse/__init__.py

@@ -33,7 +33,7 @@ from .types import (
     Warning,
 )
 
-__version__ = "0.3.2"  # x-release-please-version
+__version__ = "0.3.3"  # x-release-please-version
 
 __all__ = [
     "SPEC_VERSION",

{trackparse-0.3.2 → trackparse-0.3.3}/src/trackparse/_data.py

@@ -5,7 +5,7 @@ from __future__ import annotations
 
 from typing import Any
 
-SPEC_VERSION = "0.3.2"  # x-release-please-version
+SPEC_VERSION = "0.3.3"  # x-release-please-version
 
 # spec/data/descriptors.json
 DESCRIPTORS_DATA: dict[str, Any] = {