Skip to main content

API for Wordsmith

Project description

py3_wordsmith
=========

### About

**API for Wordsmith**

* Allows user to create narratives by passing data through the API.
* You can also pull down project lists, template lists, and data types


**Installation**

```pip install py3_wordsmith```

**Requirements**
* Written for Python 3.3+
* Requires a Wordsmith account to use.

**Parameters**
* API key
- Can be found inside your Wordsmith account
* Version
- Can be found in Wordsmith's API docs. Currently built using v0.1

### Request a Narrative
**See example.py**


**Returns JSON**
```[{'narrative': {'content': 'This is an awesome narrative that was generated by wordsmith! You can now go on to create amazing narratives using almost any kind of data set that you can imagine.'}, 'raw_data': {'bedrooms': 1.0, 'elementary_rating_numeric': 1.0, 'address_state': 'Text', 'basement': 'Text', 'house_style': 'Text', 'bathrooms': 1.0, 'middle_rating': 'Text', 'price_per_sq_ft': 1.0, 'lot_size_sq_ft': 1.0, 'address_street': 'Text', 'num_floors': 1.0, 'elementary_rating': 'Text', 'id': 1.0, 'parking_type': 'Text', 'flooring': '[1, 2, 3, 4]', 'middle_rating_numeric': 1.0, 'sale_price': 120.0, 'lot_size_acre': 1.0, 'elementary_school': 'Text', 'zpid': 1.0, 'heating_source': 'Text', 'call_address': 'Text', 'roof_type': 'Text', 'finished_sq_ft': 33.0, 'high_rating': 'Text', 'middle_school': 'Text', 'high_rating_numeric': 1.0, 'neighborhood': 'Text', 'year_built': 1987.0, 'last_sold_date': 'Text', 'avg_price_per_sq_ft': 1.0, 'address_city': 'Text', 'high_school': 'Text'}}]```


### Credits
* Connecting to Wordsmith heavily based off John Hegele's wrapper for Python 2

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

py3_wordsmith-1.1.1.tar.gz (3.5 kB view details)

Uploaded Source

Built Distribution

py3_wordsmith-1.1.1-py3-none-any.whl (5.6 kB view details)

Uploaded Python 3

File details

Details for the file py3_wordsmith-1.1.1.tar.gz.

File metadata

File hashes

Hashes for py3_wordsmith-1.1.1.tar.gz
Algorithm Hash digest
SHA256 ea7dd519a3402229555bd3c7171aa614a860133befe109ffd2f767f4c6d52745
MD5 126f639386e7c1ed82d8820018c1674b
BLAKE2b-256 a0195687fb5b42c3ff2076858198973cbb9c605bb25ab3119fa872c774aa7015

See more details on using hashes here.

File details

Details for the file py3_wordsmith-1.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for py3_wordsmith-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b239eaf925a0988ab89fc71e89de7afc4cb0a4a1df101aad605e4c00fb1360b3
MD5 4b3155d9c440a42ac0d7670aa72bba3a
BLAKE2b-256 5633ef717e825049bed97732674aaa1ed55ef347cd0c954869554ddb1337131d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page