https://github.com/aschleg/poetpy
Python wrapper for the PoetryDB API
https://github.com/aschleg/poetpy
api-wrapper database language literature poetry python python3
Last synced: 6 months ago
JSON representation
Python wrapper for the PoetryDB API
- Host: GitHub
- URL: https://github.com/aschleg/poetpy
- Owner: aschleg
- License: gpl-2.0
- Created: 2018-06-19T04:08:40.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-09-01T14:51:40.000Z (about 6 years ago)
- Last Synced: 2024-10-18T23:18:21.886Z (12 months ago)
- Topics: api-wrapper, database, language, literature, poetry, python, python3
- Language: Python
- Homepage: http://poetpy.readthedocs.io/
- Size: 223 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Poetpy
[](https://poetpy.readthedocs.io/en/latest/?badge=latest)
[](https://travis-ci.org/aschleg/poetpy)
[](https://ci.appveyor.com/project/aschleg/poetpy)
[](https://www.codacy.com/app/aschleg/poetpy?utm_source=github.com&utm_medium=referral&utm_content=aschleg/poetpy&utm_campaign=Badge_Grade)
[](https://coveralls.io/github/aschleg/poetpy?branch=master)
Python wrapper of the [PoetryDB API](http://poetrydb.org/).
## Installation
`poetpy` is must easily installed using `pip`.
~~~ python
pip install poetpy
~~~
Otherwise, the project repository can be download and installed through invoking the
`python install` command.
~~~ python
python setup.py install
~~~
## Examples
Extracting poetry and poets from the PoetryDB API requires at least one `input_term`
parameter. The `input_term` parameter results can be further refined with a corresponding
search term. For example, let's say we are interested in finding all of William Shakespeare's
poems and sonnets available in the PoetryDB API.
~~~ python
w = poetpy.get_poetry('author', 'William Shakespeare')
~~~
In the above example, the `input_term` is 'author' and the author we are interested
in finding is 'William Shakespeare'.
If we wanted to only output the lines and line counts of all of Shakespeare's poetry and sonnets,
we can use the `output` parameter to narrow the returned results.
~~~ python
w = poetpy.get_poetry('author', 'William Shakespeare', 'lines,linecounts')
~~~
The default output format from the PoetryDB API is JSON; however, we can change the
output to text by specifying the `output_format` parameter.
~~~ python
w = poetpy.get_poetry('author', 'William Shakespeare', 'lines,linecounts', 'text')
~~~
The output text format will be newline escaped.
Combination searches are also allowed to enable users to further refine the returned search results.
Each `input_term` should be given a corresponding search term delimited by a semi-colon. For example,
let's say we want to find all of []John Milton's](https://en.wikipedia.org/wiki/John_Milton) poetry
with [*Paradise Lost*](https://en.wikipedia.org/wiki/Paradise_Lost) in the title.
~~~ python
get_poetry('title,author', 'Paradise Lost;Milton')
~~~
Different `input_term` parameter combinations can also be performed. Taking the above example,
let's say we are actually only interested in finding Wordworth's poem *I Wandered Lonely As A Cloud*.
~~~ python
w = poetpy.get_poetry('author,title', 'William Shakespeare;I Wandered Lonely As A Cloud')
~~~
## Further Examples and Notebooks
[](https://mybinder.org/v2/gh/aschleg/poetpy/master?filepath=notebooks)
A set of [Jupyter Notebooks](http://jupyter.org/) that further explore the potential usage of `poetpy`
and the PoetryDB API. The notebooks can also be opened interactively using [binder](https://mybinder.org/)
* [Introduction to `poetpy`](https://github.com/aschleg/poetpy/blob/master/notebooks/Introduction%20to%20Poetpy.ipynb)
* [Building a Poetry Database in `PostgreSQL` with Python, `poetpy`, `pandas` and `sqlalchemy`](https://github.com/aschleg/poetpy/blob/master/notebooks/Building%20a%20Poetry%20Database%20in%20PostgreSQL%20with%20Python%2C%20poetpy%2C%20pandas%20and%20sqlalchemy.ipynb)
## Requirements
* Python 3.4+
* `requests >= 2.18`
## See Also
* [PoetryDB](https://github.com/thundercomb/poetrydb) Github page with more information
regarding the implementation and design of PoetryDB and its API. The README of the
repository also contains other examples for working with the API (though not in Python).
## About PoetryDB
[PoetryDB](http://poetrydb.org/index.html) was created and is currently maintained by
[@thundercomb](https://twitter.com/thundercomb). They blog about poetry and related technology and
other topics at [thecombedthunderclap.blogspot.com](http://thecombedthunderclap.blogspot.com/).
Please note, I am in no way affiliated with the creator of PoetryDB. My intention with `poetpy` is to
help spread the word and hopefully increase interest in poetry and related projects that attempt to
create comprehensive databases of publicly available knowledge.
## License
GPL-2.0