Skip to content

Commit

Permalink
Add wikidata documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
fangyizhu committed Aug 26, 2024
1 parent 0750c45 commit dd6c7c3
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 6 deletions.
3 changes: 0 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,9 +133,6 @@ First, bump up the release version in setup.py.
Run this command to build package:
`python -m build`

Run this if building on Windows:
`py -m build`

Run checks before releasing to PyPI:
`twine check --strict dist/*`

Expand Down
21 changes: 18 additions & 3 deletions artist_getter.egg-info/PKG-INFO
Original file line number Diff line number Diff line change
Expand Up @@ -99,14 +99,29 @@ The dictionary is parsed from [this json file on ULAN](http://vocab.getty.edu/ul
#### 5. get_getty_artist_sex

`get_getty_artist_name` which consumes an ULAN and returns just the artist's sex as a string, available sexes are '
male', 'female' and 'unknown'
`get_getty_artist_name("500024301")`
```male```
male', 'female' and None if unknown.
`get_getty_artist_sex("500024301")`

`male`

### WikiData Functions
#### 1. get_wiki_artist_data
`get_wiki_artist_data` consumes a WikiData ID like `Q948598` and returns the entire data set from WikiData.

#### 2. get_wiki_artist_name
`get_wiki_artist_data` consumes a WikiData ID and returns the artist name in 'First Last' format, as seen on WikiData.

`get_wiki_artist_name("Q948598")`

`Albert Pinkham Ryder`

#### 3. get_wiki_artist_sex
`get_wiki_artist_sex` which consumes a WikiData ID and returns just the artist's gender and sex as a string, available sexes are '
male', 'female' and None if unknown.

`get_wiki_artist_sex("Q948598")`

`male`

### Example View

Expand Down
Binary file modified dist/artist_getter-0.4-py3-none-any.whl
Binary file not shown.
Binary file modified dist/artist_getter-0.4.tar.gz
Binary file not shown.

0 comments on commit dd6c7c3

Please sign in to comment.