GitXplorerGitXplorer
j

reconciler

public
24 stars
6 forks
3 issues

Commits

List of commits on branch master.
Unverified
2c89205970e6c401f27e42f5005cfbb8a5ef0b17

Bump version: 0.2.1 → 0.2.2

jjvfe committed 2 years ago
Unverified
b89657a03c95f2eedda1c8b27e7591e3a61578cd

fix: Intstall missing module in docs CI

jjvfe committed 2 years ago
Verified
cf0ca99c9a2d7af611fbff3361defeb6d769590a

feat: Add logging (#16)

eedsu committed 2 years ago
Unverified
9aded75f99cdf953e2bded202b9f1537763dfd0c

ci: Update python versions

jjvfe committed 2 years ago
Unverified
a0eda39675001726321d18147ed2d8af5333a36d

docs: Fix broken references

jjvfe committed 4 years ago
Unverified
15b993a1c5b51c832a575f63dca76608ca60cf42

Bump version: 0.2.0 → 0.2.1

jjvfe committed 4 years ago

README

The README file for this repository.

reconciler

license pytest status documentation status DOI

reconciler is a python package to reconcile tabular data with various reconciliation services, such as Wikidata, working similarly to what OpenRefine does, but entirely within Python, using Pandas.

Quickstart

You can install the latest version of reconciler from PyPI with:

pip install reconciler

Then to use it:

from reconciler import reconcile
import pandas as pd

# A DataFrame with a column you want to reconcile.
test_df = pd.DataFrame(
    {
        "City": ["Rio de Janeiro", "São Paulo", "São Paulo", "Natal"],
        "Country": ["Q155", "Q155", "Q155", "Q155"]
    }
)

# Reconcile against type city (Q515), getting the best match for each item.
reconciled = reconcile(test_df["City"], type_id="Q515")

The resulting dataframe would look like this:

id match name score type type_id input_value
Q8678 True Rio de Janeiro 100 city Q515 Rio de Janeiro
Q174 True São Paulo 100 city Q515 São Paulo
Q131620 True Natal 100 municipality of Brazil Q3184121 Natal

In case you want to ensure the results are cities from Brazil, you can specify the property_mapping argument with a specific property-value pair:

# Reconcile against type city (Q515) and items have the country (P17) property equals to Brazil (Q155)
reconciled = reconcile(test_df["City"], type_id="Q515", property_mapping={"P17": test_df["Country"]})

Options

The reconcile() function accepts several options.

  • type_id - The type of items to reconcile against per the API specification.
  • top_res - Either the number of results to return per entry or the string 'all' to return all results.
  • property_mapping - A list of properties to filter results on per the API specification.
  • reconciliation_endpoint - The reconciliation service to connect to. Defaults to https://wikidata.reconci.link/en/api.

Other very useful packages

Although my opinion may be biased, I think reconciler is a pretty nice package. But the thing is, it probably won't fulfill all your Wikidata-related needs. Here are other packages that could help with that:

  • WikidataIntegrator has a lot of very nice, low-level, functions for dealing with various wikidata-related activities, such as item acquisition and programmatic editing.

  • wikidata2df is a very simple utility package for quickly and easily turning wikidata SPARQL queries into Pandas DataFrames.