Metadata-Version: 2.1
Name: PyTwits
Version: 1.0.1
Summary: PyTwits is a REST-API Wrapper for StockTwits.
Home-page: https://github.com/tbienias/PyTwits
Author: Tim Bienias
Author-email: 
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Requires-Dist: requests

<p align="center">
  <img src="https://raw.githubusercontent.com/tbienias/PyTwits/master/logo.png">
</p>

PyTwits is a REST-API Wrapper for the Social Trading Network StockTwits.
Written in Python it enables the user to easily interact with StockTwits REST-API.

## Installation ##

```bash
pip install PyTwits
```

## Example Usage ##

Following example finds AAPL symbol and prints symbol label and title.

```python
import pytwits


def main():

    stocktwits = pytwits.StockTwits()
    symbols = stocktwits.search(path='search/symbols', q='AAPL')
    aapl = symbols[0]
    print("Symbol: {} - Title: {}".format(aapl.symbol, aapl.title))


if __name__ == '__main__':
    main()
```

### Output ###

`Symbol: AAPL - Title: Apple Inc.`

## Documentation ##

Documentation consists of examples for every API entry point.
See docs/examples folder.

## License ##

MIT


