<commit_before>pystocks
========

Pystocks is a simple utility that can be used to gather basic information about a certain stock. It gathers its data from Yahoo Finance.

Usage
========

Pystocks requires Python 3 and ystockquote >= 0.2.5 which is currently not available on PyPI so must be acquired through github.

	git clone git://github.com/cgoldberg/ystockquote.git
	cd ystockquote
	python setup.py install

After ystockquote is installed, pystocks should be able to run with the command:

	python pystocks.py
<commit_msg>Fixed usage description and added an example to README.md<commit_after>pystocks
========

Pystocks is a simple utility that can be used to gather basic information about a certain stock. It gathers its data from Yahoo Finance.

Usage
========

Pystocks requires Python 3 and ystockquote >= 0.2.5 which is currently not available on PyPI so must be acquired through github.

	git clone git://github.com/cgoldberg/ystockquote.git
	cd ystockquote
	python setup.py install

After ystockquote is installed, pystocks should be able to run with the command:

	python pystocks.py <TICKER>

Depending on your platform and Python installation, you may need to run python3 inplace of python.

Example Usage:

	python pystocks.py AAPL AMZN KRFT YHOO

{'fraction_non_alphanumeric': 0.06398104265402843, 'fraction_numerical': 0.0071090047393364926, 'mean_word_length': 4.484848484848484, 'pattern_counts': {'":': 0, '<': 4, '<?xml version=': 0, '>': 6, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '272827', 'n_tokens_mistral': 367, 'n_tokens_neox': 351, 'n_words': 171}