Skip to main content

ISCC Web Service API

Project description

iscc-service - ISCC Web Service API

Version Downloads Pulls

A REST OpenAPI Backend for creating ISCC codes for digital media files.

Note: This is work in progress. Use with care and at your own risk

The Webservice is build with FastAPI and makes use of the ISCC reference implementation and the ISCC Command Line Tool and includes an interactive API documentation:

Interactive ISCC Api Docs

The Docker image is published at https://hub.docker.com/r/titusz/iscc-service

Setup for development

If you are using poetry:

  • After checkout cd into code directory and run 'poetry install' to install dependencies.
  • Launch dev server with: 'uvicorn iscc_service.main:app --reload'
  • See API docs at: http://127.0.0.1:8000

For the 'lookup' endpoint to work you must provide env variables for node connection. See config.py

Install via pip

$ pip3 install iscc-service

Run webservice via uvicorn

$ isccservice
INFO:     Started server process [18800]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)

Publishing on Docker HUB:

docker login
docker build -t iscc-service -f Dockerfile .
docker run --rm -p 8080:8080 -it iscc-service
docker tag iscc-service username/iscc-service:0.1.9
docker push username/iscc-service:0.1.9

Change Log

[0.2.2] - 2020-06-12

  • Update to iscc-cli 0.9.11

[0.2.1] - 2020-05-13

  • Update to iscc-cli 0.9.8
  • More conservative lookup matching

[0.2.0] - 2020-05-01

  • Update to support flac and opus audio files

[0.1.9] - 2020-04-27

  • Support updated Content-ID Audio
  • Support incomplete ISCC codes
  • Updated dependencies

[0.1.8] - 2020-03-02

  • Add support for mobi files
  • Initial pypi release

License

MIT © 2019-2020 Titusz Pan

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

iscc-service-0.2.2.tar.gz (7.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

iscc_service-0.2.2-py3-none-any.whl (8.9 kB view details)

Uploaded Python 3

File details

Details for the file iscc-service-0.2.2.tar.gz.

File metadata

  • Download URL: iscc-service-0.2.2.tar.gz
  • Upload date:
  • Size: 7.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.5 CPython/3.6.4 Windows/10

File hashes

Hashes for iscc-service-0.2.2.tar.gz
Algorithm Hash digest
SHA256 f9c57388a221af09685b3ddcdcffc9704dd5aab9c64ec8fd1bd78d05da00c863
MD5 5dae590cd3a400278ee2e655fdc5fce4
BLAKE2b-256 863f2b456ffe6baa38cbafc32312863e7f404f76e922b9c853e078827952e670

See more details on using hashes here.

File details

Details for the file iscc_service-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: iscc_service-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 8.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.5 CPython/3.6.4 Windows/10

File hashes

Hashes for iscc_service-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3d297faeb766b9342428e1e28787f0f28c1be09fecffb10c120616da02fa9a0f
MD5 d3a90fb2a27ac31afc708eea9371b718
BLAKE2b-256 017051fd6d446f7c602dc480abbacd5f271b45dad03994e9e94c6953e47c1c42

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page