TMDb

TMDb – Die Filmdatenbank

Ein Swift-Paket für The Movie Database (TMDb) https://www.themoviedb.org

Anforderungen

• Swift 6.0+
• Betriebssystem
  • macOS 13+
  • iOS 16+
  • watchOS 9+
  • tvOS 16+
  • visionOS 1+
  • Windows
  • Linux

Installation

Swift-Paketmanager

Fügen Sie das TMDb-Paket als Abhängigkeit zu Ihrer Package.swift Datei hinzu und fügen Sie es als Abhängigkeit zu Ihrem Ziel hinzu.

 // swift-tools-version:5.9

import PackageDescription

let package = Package (
  name : " MyProject " ,

  dependencies : [
    . package ( url : " https://github.com/adamayoung/TMDb.git " , from : " 13.0.0 " )
  ] ,

  targets : [
    . target ( name : " MyProject " , dependencies : [ " TMDb " ] )
  ]
)

Xcode-Projekt

Fügen Sie das TMDb-Paket zu den Paketabhängigkeiten Ihres Projekts hinzu.

Aufstellen

Holen Sie sich einen API-Schlüssel

Erstellen Sie einen API-Schlüssel von der Website der Filmdatenbank https://www.themoviedb.org/documentation/api.

Schnellstart

 let tmdbClient = TMDbClient ( apiKey : " <your-tmdb-api-key> " )

let moviesToDiscover = try await tmdbClient . discover . movies ( ) . results
let fightClub = try await tmdbClient . movies . details ( forMovie : 550 ) 

Dokumentation

Dokumentation und Anwendungsbeispiele finden Sie unter https://adamayoung.github.io/TMDb/documentation/tmdb/

Entwicklung

Voraussetzungen

Xcode 16.0+ Swift 6.0+ Homebrew

Homebrew

Installieren Sie Homebrew und die folgenden Formeln

• Swiftlint
• Swiftformat
• markdownlint

brew install swiftlint swiftformat markdownlint

Bevor Sie eine PR einreichen

Unit- und Integrationstests

Als Testframework kommt Swift Testing zum Einsatz. XCTest wird nicht mehr verwendet.

Stellen Sie sicher, dass der gesamte neue Code durch Unit-Tests abgedeckt wird. Wenn neue Methoden zu Diensten hinzugefügt werden, die TMDb-API-Endpunkte aufrufen, stellen Sie sicher, dass es Integrationstests gibt, die diese abdecken.

Codierungsstil

Der Codierungsstil wird durch swift-format erzwungen.

Verwenden Sie den folgenden Befehl, um die Codebasis zu linten:

make lint

Um die Codebasis zu formatieren, verwenden Sie:

make format

DocC-Dokumentation

Stellen Sie sicher, dass alle public Klassen, Strukturen, Eigenschaften und Methoden kommentiert sind

Die DocC-Dokumentation kann lokal erstellt und gehostet werden

make preview-docs

Siehe DocC | Weitere Informationen finden Sie in der Apple-Entwicklerdokumentation.

CI-Prüfungen

Stellen Sie vor dem Einreichen einer PR sicher, dass alle CI-Prüfungen erfolgreich sind:

make ci

CI-Prüfungen bestehen aus folgenden Aufgaben:

make lint
make lint-markddown
make test
make test-ios
make test-watchos
make test-tvos
make test-visionos
make test-linux
make integration-test
make build-release
make build-docs

Um Integrationstests auszuführen, müssen die folgenden Umgebungsvariablen festgelegt werden.

• TMDB_API_KEY – Ihr TMDb-API-Schlüssel
• TMDB_USERNAME – Ihr TMDb-Benutzername
• TMDB_PASSWORD – Ihr TMDB-Passwort

Wenn diese Umgebungsvariablen nicht festgelegt sind, werden Integrationstests übersprungen, wenn make nicht verwendet wird.

Für die Ausführung von Unit-Tests unter Linux muss Docker ausgeführt werden.

Referenzen

• https://www.themoviedb.org
• https://developer.themoviedb.org

Lizenz

Diese Bibliothek ist unter der Apache-Lizenz 2.0 lizenziert. Einzelheiten finden Sie unter LIZENZ.