Wikidata powered comparisons
howmany is a Python package that leverages the Wikidata REST API to easily find and compare the dimensions of any object. You can use howmany to find the answers to questions including:
- How tall is the Eiffel Tower?
- How many association football pitches would fit inside Germany (or that giant new wind farm)?
- And eventually anything else that Wikidata has dimensions for!
Of note is also that howmany can do unit conversions for users in comparison calculations.
Contents
Installation ⇧
howmany can be downloaded from PyPI via pip or sourced directly from this repository:
pip install howmany
git clone https://github.com/andrewtavis/howmany.git
cd howmany
python setup.py install
import howmany
Environment Setup ⇧
The development environment for howmany can be installed via the following steps:
- Fork the howmany repo, clone your fork, and configure the remotes:
# Clone your fork of the repo into the current directory.
git clone https://github.com/<your-username>/howmany.git
# Navigate to the newly cloned directory.
cd howmany
# Assign the original repo to a remote called "upstream".
git remote add upstream https://github.com/andrewtavis/howmany.git
- Now, if you run
git remote -vyou should see two remote repositories named:origin(forked repository)upstream(howmany repository)
-
Use Anaconda to create the local development environment within your howmany directory:
conda env create -f environment.yml
Examples ⇧
See the example Jupyter notebook for full examples.
import howmany
from howmany.utils import (
float_to_str,
get_wd_ent_label,
get_wd_ent_prop_amount,
get_wd_ent_prop_unit,
)
Getting labels, amounts and units
eiffel_tower_qid = "Q243"
height_pid = "P2048"
eiffel_tower_label = get_wd_ent_label(qid=eiffel_tower_qid)
eiffel_tower_height = get_wd_ent_prop_amount(qid=eiffel_tower_qid, pid=height_pid)
eiffel_tower_height_unit = get_wd_ent_prop_unit(qid=eiffel_tower_qid, pid=height_pid)
print(
f"The {eiffel_tower_label} is {round(eiffel_tower_height)} {eiffel_tower_height_unit}s tall."
)
# The Eiffel Tower is 324 metres tall.
Simple comparisons of Wikidata items
germany_qid = "Q183"
soccer_field_qid = "Q8524"
area_pid = "P2046"
soccer_fields_in_germany_dict = howmany.compare(
containers=germany_qid, entities=soccer_field_qid, pid=area_pid
)
for k in soccer_fields_in_germany_dict.keys():
amount = round(soccer_fields_in_germany_dict[k]["amount"], 2)
print(
f"You could fit {amount:,} {soccer_fields_in_germany_dict[k]['entity']}es inside {k}."
)
# You could fit 50,453,300.88 association football pitches inside Germany.
germanies_in_soccer_fields_dict = howmany.compare(
containers=soccer_field_qid, entities=germany_qid, pid=area_pid
)
for k in germanies_in_soccer_fields_dict.keys():
amount = float_to_str(f=germanies_in_soccer_fields_dict[k]["amount"])
print(
f"You could fit {amount} {germanies_in_soccer_fields_dict[k]['entity']}s inside an {k}."
)
# You could fit 0.0000000198 Germanys inside an association football pitch.
Comparisons of Wikidata items with predefined amounts
# Variables defined above...
giant_new_wind_farm_label = "giant new wind farm"
area_of_giant_new_wind_farm = 50
unit_of_giant_new_wind_farm_area = "square kilometre"
soccer_fields_in_giant_new_wind_farm_dict = howmany.compare(
containers=giant_new_wind_farm_label,
container_amounts=area_of_giant_new_wind_farm,
container_units=unit_of_giant_new_wind_farm_area,
entities=soccer_field_qid,
pid=area_pid,
)
for k in soccer_fields_in_giant_new_wind_farm_dict.keys():
amount = round(soccer_fields_in_giant_new_wind_farm_dict[k]["amount"], 2)
print(
f"You could fit {amount:,} {soccer_fields_in_giant_new_wind_farm_dict[k]['entity']}es inside the {k}."
)
# You could fit 7,054.67 association football pitches inside the giant new wind farm.
Comparisons across lists of containers or entities
# Variables defined above...
import matplotlib.pyplot as plt
import seaborn as sns
all_german_state_qids = ["Q64", ...]
saarland_qid = "Q1201"
saarlands_in_german_states_dict = howmany.compare(
containers=all_german_state_qids, entities=saarland_qid, pid=area_pid # , iso="en"
)
# Code to order labels and area ratios...
ax = sns.barplot(
x=german_states_desc_saarland_area, y=german_state_desc_areas_in_saarlands
)
ax.set_title("Area of German States in Saarlands", size=18)
ax.set(xlabel="German State", ylabel="Area (Saarlands)")
ax.bar_label(ax.containers[0])
ax.xaxis.label.set_size(14)
ax.yaxis.label.set_size(14)
plt.xticks(rotation=45)
plt.show()
To-Do ⇧
Please see the contribution guidelines if you are interested in contributing to this project. Work that is in progress or could be implemented includes:
- Expand the unit conversion process in utils.py
- Keep requests below the Wikidata REST API rate limit in
howmany.compare() - Other suggestions welcome!
Powered By
Metadata
Release files for howmany 0.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| howmany-0.2.1-py3-none-any.whl | Python 3 | none | any | Details for howmany-0.2.1-py3-none-any.whl |
Release files / howmany-0.2.1-py3-none-any.whl
| Download URL | howmany-0.2.1-py3-none-any.whl |
|---|---|
| Size | 8.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
84ae80e988a93ef7deba8b326ec3abd095a1708d44783b6a68a1142317fe8d97
|
|
BLAKE2b-256 checksum How to use checksums |
fd51ecfd981bb95e5f2eb3cd7cfe5f3f00dcebc36c77be6690d22880907862cb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.13
|
Security for howmany 0.2.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.