Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
wragge committed Oct 5, 2021
1 parent 1693064 commit 61353da
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 1 deletion.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,16 @@
> Tools for downloading images from Trove's digitised newspapers and gazettes.

## Background and alternatives

There's no reliable way of downloading an image of a Trove newspaper article from the web interface. The image download option produces an HTML page with embedded images, and the article is often sliced into pieces to fit the page.

This package includes tools to download articles as complete JPEG images. If an article is printed across multiple newspaper pages, multiple images will be downloaded – one for each page. It's intended for integration into other tools and processing workflows, or for people who like working on the command line.

If you just want to quickly download an article as an image without installing anything, you can [use this web app](https://glam-workbench.net/trove-newspapers/#save-a-trove-newspaper-article-as-an-image) in the GLAM Workbench. To download images of all articles returned by a search in Trove, you can also use the [Trove Newspaper and Gazette Harvester](https://glam-workbench.net/trove-harvester/).

See the [documentation](https://wragge.github.io/trove_newspaper_images/) for more information.

## Install

`pip install git+https://github.com/wragge/trove_newspaper_images.git`
Expand Down
10 changes: 10 additions & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,16 @@
</div>
{% endraw %}

<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<h2 id="Background-and-alternatives">Background and alternatives<a class="anchor-link" href="#Background-and-alternatives"> </a></h2><p>There's no reliable way of downloading an image of a Trove newspaper article from the web interface. The image download option produces an HTML page with embedded images, and the article is often sliced into pieces to fit the page.</p>
<p>This package includes tools to download articles as complete JPEG images. If an article is printed across multiple newspaper pages, multiple images will be downloaded – one for each page. It's intended for integration into other tools and processing workflows, or for people who like working on the command line.</p>
<p>If you just want to quickly download an article as an image without installing anything, you can <a href="https://glam-workbench.net/trove-newspapers/#save-a-trove-newspaper-article-as-an-image">use this web app</a> in the GLAM Workbench. To download images of all articles returned by a search in Trove, you can also use the <a href="https://glam-workbench.net/trove-harvester/">Trove Newspaper and Gazette Harvester</a>.</p>
<p>See the <a href="https://wragge.github.io/trove_newspaper_images/">documentation</a> for more information.</p>

</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<h2 id="Install">Install<a class="anchor-link" href="#Install"> </a></h2>
Expand Down
9 changes: 8 additions & 1 deletion index.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,14 @@
"source": [
"# Trove newspaper images\n",
"\n",
"> Tools for downloading images from Trove's digitised newspapers and gazettes.\n",
"> Tools for downloading images from Trove's digitised newspapers and gazettes."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Background and alternatives\n",
"\n",
"There's no reliable way of downloading an image of a Trove newspaper article from the web interface. The image download option produces an HTML page with embedded images, and the article is often sliced into pieces to fit the page.\n",
"\n",
Expand Down

0 comments on commit 61353da

Please sign in to comment.