Skip to content

Commit 783a3cb

Browse files
committed
docs: add data source docs and contribution guide
1 parent 3deb7d5 commit 783a3cb

6 files changed

Lines changed: 59 additions & 3 deletions

File tree

CONTRIBUTING.md

100644100755
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,14 @@ libquery_extensions/ - the Python package
3636

3737
Use [Black](https://github.com/psf/black) to detect code style issues and fix the issues before committing.
3838

39+
## Publishing the Package
40+
41+
The steps to publish the package:
42+
43+
1. Bump the version in `pyproject.toml`.
44+
2. create a new tag for the version with `git tag v*.*.*`.
45+
3. push the tag to Github with `git push origin v*.*.*`, which will trigger the Github workflow at `.github/workflow/publish-to-pypi.yml` to automatically publish the package to PyPI.
46+
3947
## Thanks
4048

4149
Thank you again for being interested in this project! You are awesome!
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Alabama Maps
2+
3+
**URL:** <http://alabamamaps.ua.edu/historicalmaps/>
4+
5+
**Contributor:**
6+
- Collector: [Cartographic Research Laboratory](http://alabamamaps.ua.edu/cartlab/index.html) at the University of Alabama ([reference](http://alabamamaps.ua.edu/about.html))
7+
- Original Data Sources: this [link](http://alabamamaps.ua.edu/historicalmaps/about.html) describes the source of 69285 maps
8+
9+
**Data Source Size:** 77309 maps + 53869 aerial photos ([reference](http://alabamamaps.ua.edu/index.html)) (last accessed on 2023/10/19)
10+
11+
**Term of Use:**
12+
> The Historical Map Archive is a digitized collection of selected map holdings from the University of Alabama Map Library, the W. S. Hoole Special Collections Library, the Rucker Agee Collection of the [Birmingham Public Library](http://www.bham.lib.al.us/), the [Geological Survey of Alabama](http://www.gsa.state.al.us/), and the [Alabama Department of Archives and History](https://www.archives.state.al.us/). We are indebted to these organizations for their cooperation in facilitating the introduction of these digital maps to the Internet. Maps located in the Historical Map Archive may be used in publication only if permission is given by the map owner. This information can be found under the heading "Original Source" in the information for each map. Interested parties may contact us at alabama.maps@ua.edu, and we will be happy to provide the owner's contact information. ([Source](http://alabamamaps.ua.edu/about.html))
13+
14+
**Last Update:** 2022/05/25 ([reference](http://alabamamaps.ua.edu/index.html))
15+
16+
**Search Function:** [link](http://alabamamaps.ua.edu/searchengine.htm)

libquery_extensions/alabama_maps/_fetch_metadata.py

100644100755
Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
"""
22
Utility functions for getting metadata from Alabama Maps.
3+
4+
Implementation Notes
5+
--------------------
6+
1. Alabama Maps website does not provide search function.
7+
Thus, the user needs to manually gather the URLs of pages
8+
to be processed by operating in the navigation page.
39
"""
410

511
import os
@@ -53,11 +59,12 @@ def _parse_download_url(view_url: str, driver: webdriver.Chrome) -> str:
5359
parse_result = parse.urlparse(download_url)
5460
query = parse.parse_qs(parse_result.query)
5561

56-
# Decides the resolution of the returned image
62+
# Get a high-resolution image download URL:
63+
# - Set the resolution of the returned image.
5764
query["lev"] = 0
58-
# Decides the width of the returned image
65+
# - Set the width of the returned image.
5966
query["wid"] = 5000
60-
# Decides the height of the returned image
67+
# - Set the height of the returned image.
6168
query["hei"] = 4000
6269

6370
del query["props"]
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# British Library Collection Items
2+
3+
**URL:** <https://www.bl.uk/collection-items?page=1>
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# British Library Images Online
2+
3+
**URL:** <https://imagesonline.bl.uk>
4+
5+
**Term of Use:**
6+
> Please note that all images on Images Online except for those in Copyright are available to download as JPEGs free of charge at dimensions of 2000px (long-side) at 300 PPI. This is sufficient quality to print up to A5. Please use the Free Download option in the drop-down menu when selecting images. Any image(s) downloaded this way are free to use without restriction. The images are not made available as Public Domain, and will need to be credited © British Library Board (including the shelfmark, folio/page number) when used. ([Source](https://imagesonline.bl.uk/))
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Telefact: 1938-1945 by Pictograph Corporation
2+
3+
**URL:** <https://modley-telefact-1939-1945.tumblr.com>
4+
5+
**Contributor:**
6+
- [Jason Forrest](https://www.jasonforrestftw.com/) (collector)
7+
- [Rudolf Modley](https://en.wikipedia.org/wiki/Rudolf_Modley) (creator)
8+
9+
**Data Source Content:**
10+
> Telefact was a syndicated series of isotypes by the Pictograph Corporation. Rudolf Modley (1906 - 1976) was an Austrian-American research executive, graphic designer, management consultant and author, who founded Pictorial Statistics Inc. in 1934. He illustrated and wrote a series of books on pictorial statistics and pictorial symbolism. Modley is known for introducing and populizing the Isotype picture language in the United States, whereby he developed an own version of pictorial statistics. He also designed many pictorial symbols in the 1930s and 1940s, and worked on standardization of pictorial symbols. These images were found in various newspapers, digitized, and edited by Jason Forrest in April 2020. For more: https://www.jasonforrestftw.com. ([Source](https://modley-telefact-1939-1945.tumblr.com/) last accessed on 2023/10/19)
11+
12+
**Data Source Size:** 264 (as of 2022/06/26)
13+
14+
**Term of Use:** Unknown
15+
16+
**Related Blog:** <https://medium.com/nightingale/the-telefacts-of-life-rudolf-modleys-isotypes-in-american-newspapers-1938-1945-d5478faa5647>

0 commit comments

Comments
 (0)