TMDb

TMDb — База данных фильмов

Пакет Swift для базы данных фильмов (TMDb) https://www.themoviedb.org

Требования

• Свифт 6.0+
• ОС
  • macOS 13+
  • iOS 16+
  • смотретьOS 9+
  • ТВОС 16+
  • видениеOS 1+
  • Окна
  • Линукс

Установка

Менеджер пакетов Swift

Добавьте пакет TMDb в качестве зависимости к вашему файлу Package.swift и добавьте его в качестве зависимости к вашей цели.

 // 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-проект

Добавьте пакет TMDb в зависимости пакета вашего проекта.

Настраивать

Получить ключ API

Создайте ключ API на веб-сайте базы данных фильмов https://www.themoviedb.org/documentation/api.

Быстрый старт

 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 ) 

Документация

Документацию и примеры использования можно найти по адресу https://adamayoung.github.io/TMDb/documentation/tmdb/.

Разработка

Предварительные условия

Xcode 16.0+ Swift 6.0+ Доморощенный

Домашнее пиво

Установите доморощенный и следующие формулы

• Свифтлинт
• SwiftFormat
• Маркдаунлинт

brew install swiftlint swiftformat markdownlint

Прежде чем подавать PR

Модульные и интеграционные тесты

В качестве среды тестирования используется Swift Testing. XCTest больше не используется.

Убедитесь, что весь новый код покрыт модульными тестами. Если в сервисы, которые осуществляют вызовы к конечным точкам API TMDb, добавляются какие-либо новые методы, убедитесь, что они охватываются интеграционными тестами.

Стиль кодирования

Стиль кодирования обеспечивается swift-format .

Используйте следующую команду для проверки базы кода:

make lint

Для форматирования базы кода используйте:

make format

Документация ДокС

Убедитесь, что все public классы, структуры, свойства и методы прокомментированы.

Документация DocC может быть создана и размещена локально на

make preview-docs

См. документ | Документацию разработчика Apple для получения более подробной информации.

CI-проверки

Прежде чем отправлять запрос на запрос, убедитесь, что все проверки CI пройдены:

make ci

Проверки CI состоят из следующих задач:

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

Для запуска интеграционных тестов необходимо установить следующие переменные среды.

• TMDB_API_KEY — ваш ключ API TMDb.
• TMDB_USERNAME — ваше имя пользователя TMDb.
• TMDB_PASSWORD — ваш пароль TMDB.

Если эти переменные среды не установлены, интеграционные тесты пропускаются, если не используется make .

Для запуска модульных тестов в Linux требуется запуск Docker.

Ссылки

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

Лицензия

Эта библиотека распространяется по лицензии Apache License 2.0. Подробности см. в разделе ЛИЦЕНЗИЯ.