Skip to content

Commit cd4f64b

Browse files
authored
Update README.md
1 parent 5345581 commit cd4f64b

File tree

1 file changed

+14
-17
lines changed

1 file changed

+14
-17
lines changed

README.md

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,19 @@
1-
# iiify
2-
A simple Python Flask-based implementation of the IIIF Image API 1.0 standard
3-
4-
## Notes
5-
* This started as a toy project to learn the IIIF API, so it is not necessarily ready for production, but may be some day.
6-
* It was also an opportunity to learn Flask, a micro-framework. I consciously chose to avoid adding too many abstractions, and attempted to stick to procedural code as much as possible.
7-
* It has a simple on-disk cache scheme, but no cache management.
8-
* If you want to delete the cache, purge the contents of the cache directory.
9-
* Cache does not currently check timestamps.
10-
* Cache can't be disabled yet.
11-
* It was a lot of fun, and does work, but is missing a lot of optimizations.
12-
* There are several sample files in the media directory - all but one are courtesy of the Getty's Open Content Program.
1+
# iiif.archive.org
2+
3+
The Internet Archive's official IIIF 3.0 Image & Presentation API
4+
5+
## Background
6+
7+
This service replaces the iiif.archivelab.org unofficial labs API.
8+
9+
## Technical Details
10+
11+
The service uses a manifest/API service written in python3 flask and makes image processing calls to cantaloupe in both iiif 3.0 and 2.0 format.
1312

1413
## Installation & Setup
1514
```
16-
git clone https://github.com/ArchiveLabs/iiif.archivelab.org.git
17-
cd iiif.archivelab.org
15+
git clone https://github.com/internetarchive/iiif.git
16+
cd iiif
1817
pip install .
1918
python app.py
2019
```
@@ -33,7 +32,7 @@ docker run -d --rm --name iiify -p 8080:8080 iiify-uwsgi
3332

3433
Navigate to http://127.0.0.1:8080/iiif
3534

36-
## Test it!
35+
## Testing
3736

3837
Unit tests are in the `tests` folder and can be run with:
3938
```
@@ -48,5 +47,3 @@ Crop into large.jpg and return 800px wide JPEG
4847

4948
Mirror large.jpg horizontally and return 800px wide JPEG
5049
* http://127.0.0.1:8080/iiif/large.jpg/full/800,/!0/default.jpg
51-
52-
For more information, read the specification at http://iiif.io/technical-details.html

0 commit comments

Comments
 (0)