| Name | pincushion JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | None |
| Summary | An archiving tool for Historypin |
| upload_time | 2024-10-21 00:28:33 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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 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
```shell
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.
[Historypin]: https://historypin.org
[Historypin API]: https://historypin.github.io/api-docs/
Raw data
{
"_id": null,
"home_page": null,
"name": "pincushion",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/a1/72/3dc435c74d03829f6c07d261a7f5bf0b6910d8d0930f195bbab41cc8c5b6/pincushion-0.2.0.tar.gz",
"platform": null,
"description": "# pincushion\n\n*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 file structure looks something like:\n\n```\narchive\n\u251c\u2500\u2500 collections\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 my-collection\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 image.jpg\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2514\u2500\u2500 index.html\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 my-other-collection\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 image.jpg\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2514\u2500\u2500 index.html\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 my-last-collection\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 image.jpg\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 index.html\n\u251c\u2500\u2500 data.json\n\u251c\u2500\u2500 index.html\n\u251c\u2500\u2500 pins\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 123 \n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 image.jpg\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2514\u2500\u2500 index.html\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 456\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 image.jpg\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2514\u2500\u2500 index.html\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 789 \n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 image.jpg\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2514\u2500\u2500 index.html\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 1001 \n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 index.html\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2514\u2500\u2500 media.mp3\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 2112\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 index.html\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 media.mp4\n\u2514\u2500\u2500 user.jpg\n```\n\nEach 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.\n\n## Install\n\n```shell\npip install pincushion\n```\n\n## Use\n\nCreate an archive for user 11670:\n\n```\npincushion user --user-id 11670 --archive-path my-archive\n```\n\nOpen the `my-archive/index.html` file in your browser.\n\n[Historypin]: https://historypin.org\n[Historypin API]: https://historypin.github.io/api-docs/\n",
"bugtrack_url": null,
"license": null,
"summary": "An archiving tool for Historypin",
"version": "0.2.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "ab0d6cee7124b1618c2b600fec18404d3c903ddf4ab93fda6c723e16c668211b",
"md5": "e61c7318d5b30b4f0126511760d472d6",
"sha256": "add4b1a633dcf1d685832b04fe96f80072c17871ebf64327a186cac703a60c58"
},
"downloads": -1,
"filename": "pincushion-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e61c7318d5b30b4f0126511760d472d6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 75793,
"upload_time": "2024-10-21T00:28:33",
"upload_time_iso_8601": "2024-10-21T00:28:33.968595Z",
"url": "https://files.pythonhosted.org/packages/ab/0d/6cee7124b1618c2b600fec18404d3c903ddf4ab93fda6c723e16c668211b/pincushion-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "a1723dc435c74d03829f6c07d261a7f5bf0b6910d8d0930f195bbab41cc8c5b6",
"md5": "2e5d2fd6b9a87229960049eb2179054d",
"sha256": "7bc3ae2f0a22d29485fd8d88a7c859d50f78552d449144f282450c7d52675fc2"
},
"downloads": -1,
"filename": "pincushion-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "2e5d2fd6b9a87229960049eb2179054d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 74780,
"upload_time": "2024-10-21T00:28:33",
"upload_time_iso_8601": "2024-10-21T00:28:33.075170Z",
"url": "https://files.pythonhosted.org/packages/a1/72/3dc435c74d03829f6c07d261a7f5bf0b6910d8d0930f195bbab41cc8c5b6/pincushion-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-21 00:28:33",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pincushion"
}
