Wikidata powered comparisons
Project description
Wikidata powered comparisons
howmany is a Python package that uses Wikidata entity properties to easily compare the dimensions of any object. You can use it to find the answers to questions including:
- How many association football pitches would fit inside Germany?
- And eventually anything else that Wikidata has dimensions for!
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:
[!NOTE]
Consider using SSH
Alternatively to using HTTPS as in the instructions below, consider SSH to interact with GitHub from the terminal. SSH allows you to connect without a user-pass authentication flow.
To run git commands with SSH, remember then to substitute the HTTPS URL,
https://github.com/...
, with the SSH one,git@github.com:...
.
- e.g. Cloning now becomes
git clone git@github.com:<your-username>/howmany.git
GitHub also has their documentation on how to Generate a new SSH key 🔑
# 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 -v
you 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 ⇧
As of now howmany does one thing:
python src/howmany/in.py
# You could fit 50,453,300.88 association football pitches inside Germany.
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:
- WIP
Powered By
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.