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.3] - 2020-06-12

  • Use vendorized tika

[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.3.tar.gz (7.9 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: iscc-service-0.2.3.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.3.tar.gz
Algorithm Hash digest
SHA256 8c6f0463e92d478832e1c8d0f51234f625ed0839e0f9110b70572f6eb87d6927
MD5 dd1ba62dbd42ff386650de6ac27ec26b
BLAKE2b-256 6691726d1fb2a0f9c3fb1160ab70bd100ea053a1d856d4027b17126f0ed01f15

See more details on using hashes here.

File details

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

File metadata

  • Download URL: iscc_service-0.2.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 33753bdf59a0dd35745750fda40bb5aa85857f23cb636c779b0ace689914c334
MD5 0faa4c5f518472f2cce9ddd73c0d5454
BLAKE2b-256 e53882db26da71db901db33dc364faad21ff175ad8024c6d7b87ea8109ec6b1c

See more details on using hashes here.

Supported by

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