Skip to main content

An archiving tool for Historypin

Project description

pincushion

Test

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.5.0.tar.gz (76.4 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.5.0-py3-none-any.whl (77.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pincushion-0.5.0.tar.gz
Algorithm Hash digest
SHA256 9326c7be19d36ded531645d4ad80215f3896df23ce607fb818be6799942f5363
MD5 6e4385e7a7e1729d0dcdd64cf5db1844
BLAKE2b-256 356199fd1df080022e2616c432467ba689e1263bc7b234a64d56563a98f07ab6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pincushion-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ef362d19e80bd51aeaf07a466d7f5364b74c66ae4670f6d3a53c32d8f1040990
MD5 174097a9d15adfa460606b923a7429bc
BLAKE2b-256 3f50fb4e4518b7f44db4e53bf77f4b5b8044b79210cd670ce7aa5c257560093d

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