Skip to main content

An archiving tool for Historypin

Project description

pincushion

pincushion is a command line tool for creating archives for resources on Historypin. It reads data from the Historypin API and writes a static website to a given directory. The resulting file structure looks something like:

archive
├── collections
│   ├── my-collection
│   │   ├── image.jpg
│   │   └── index.html
│   ├── my-other-collection
│   │   ├── image.jpg
│   │   └── index.html
│   └── my-last-collection
│       ├── image.jpg
│       └── index.html
├── data.json
├── index.html
├── pins
│   ├── 123 
│   │   ├── image.jpg
│   │   └── index.html
│   ├── 456
│   │   ├── image.jpg
│   │   └── index.html
│   ├── 789 
│   │   ├── image.jpg
│   │   └── index.html
│   ├── 1001 
│   │   ├── index.html
│   │   └── media.mp3
│   └── 2112
│       ├── index.html
│       └── media.mp4
└── user.jpg

Each pin has its own directory, which contains the uploaded media (image, audio or video). The data.json file is an aggregation of JSON data collected from the Historypin API, which is used to create the static site.

Install

pip install pincushion

Use

Create an archive for user 11670:

pincushion user --user-id 11670 --archive-path my-archive

Open the my-archive/index.html file in your browser.

Similarly you can create an archive for a "collection" as long as the collection contains sub-collections:

pincushion collection --slug 2025-summer-institute --archive-path my-collection

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

pincushion-0.3.0.tar.gz (75.9 kB view details)

Uploaded Source

Built Distribution

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

pincushion-0.3.0-py3-none-any.whl (77.2 kB view details)

Uploaded Python 3

File details

Details for the file pincushion-0.3.0.tar.gz.

File metadata

  • Download URL: pincushion-0.3.0.tar.gz
  • Upload date:
  • Size: 75.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.3

File hashes

Hashes for pincushion-0.3.0.tar.gz
Algorithm Hash digest
SHA256 626f68ebe2b320e450afb081238c1c29a9d8730910af639e42c5958c353d7ee2
MD5 12c216b9b46f39a2b065a2dd9b4644bb
BLAKE2b-256 13b4af129ab1155a5d3fa41102478dd30d8059d9dc1b9724fb6d1d7143194aff

See more details on using hashes here.

File details

Details for the file pincushion-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for pincushion-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3594b85aa0df59b9ff6d88ac180a98633db59c4ef4063646dbe201604bda5d42
MD5 4d2e45f0c42306f0ee10574f5377c627
BLAKE2b-256 98f4ee9fd94b1cbfccda66e1d621770c07d9a1ec421acf40e1ff767cc2229a52

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