TMDb

TMDb - La base de datos de películas

Un paquete Swift para The Movie Database (TMDb) https://www.themoviedb.org

Requisitos

• Rápido 6.0+
• SO
  • MacOS 13+
  • iOS 16+
  • relojOS 9+
  • tvOS 16+
  • visiónOS 1+
  • ventanas
  • linux

Instalación

Administrador de paquetes rápido

Agregue el paquete TMDb como una dependencia a su archivo Package.swift y agréguelo como una dependencia a su destino.

 // 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 " ] )
  ]
)

proyecto xcode

Agregue el paquete TMDb a las dependencias del paquete de su proyecto.

Configuración

Obtenga una clave API

Cree una clave API desde el sitio web de The Movie Database https://www.themoviedb.org/documentation/api.

Inicio rápido

 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 ) 

Documentación

La documentación y ejemplos de uso se pueden encontrar en https://adamayoung.github.io/TMDb/documentation/tmdb/

Desarrollo

Requisitos previos

Xcode 16.0+ Swift 6.0+ Cerveza casera

cerveza casera

Instale homebrew y las siguientes fórmulas

• veloz
• formato rápido
• rebajas

brew install swiftlint swiftformat markdownlint

Antes de enviar un PR

Pruebas unitarias y de integración

Swift Testing se utiliza como marco de prueba. XCTest ya no se utiliza.

Asegúrese de que todo el código nuevo esté cubierto por pruebas unitarias. Si se agrega algún método nuevo a los servicios que realizan llamadas a puntos finales de la API de TMDb, asegúrese de que haya pruebas de integración que los cubran.

Estilo de codificación

El estilo de codificación se aplica mediante swift-format .

Utilice el siguiente comando para eliminar el código base:

make lint

Para formatear el uso del código base:

make format

Documentación DocC

Asegúrese de que todas las clases, estructuras, propiedades y métodos public estén comentados.

La documentación DocC se puede crear y alojar localmente mediante

make preview-docs

Ver DocC | Documentación para desarrolladores de Apple para obtener más detalles.

Comprobaciones de CI

Antes de enviar un PR, asegúrese de que se pasen todas las comprobaciones de CI:

make ci

Las comprobaciones de CI se componen de las siguientes tareas:

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

Para ejecutar pruebas de integración, es necesario configurar las siguientes variables de entorno.

• TMDB_API_KEY : su clave API de TMDb
• TMDB_USERNAME : su nombre de usuario de TMDb
• TMDB_PASSWORD - Su contraseña de TMDB

Si estas variables de entorno no están configuradas, las pruebas de integración se omitirán cuando no se utilice make .

La ejecución de pruebas unitarias en Linux requiere que Docker esté en ejecución.

Referencias

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

Licencia

Esta biblioteca tiene la licencia Apache 2.0. Consulte LICENCIA para obtener más detalles.