Skip to content

Commit

Permalink
#1: updating documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
josuebrunel committed May 24, 2015
1 parent 97b0392 commit 690e8ec
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 42 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Yahoo! Query Language Documentation and Support
Release Notes
==============

v 1.2.2 ( development )
v 1.2.2
-------
* **Python3** support OK [#71](https://github.com/josuebrunel/myql/issues/71)
* Fixed issue with **IN** condition in **where** clause
Expand All @@ -39,7 +39,7 @@ v 1.2.2 ( development )

v 1.2.1
------
* Multiple requests while using OAuth fixed
* Multiple requests while using OAuth fixed

v 1.2.0
-------
Expand All @@ -53,7 +53,7 @@ v 0.5.6
* select data format (xml/json)
* change data source
* filter data
* fix handling of default and on the fly response format
* fix handling of default response format on the fly
* fix limit on ***select(...).where(...)*** when no limit value is passed
* fix limit on ***get(...)***

Expand Down
50 changes: 12 additions & 38 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,33 +1,17 @@
`MYQL <.>`_

- `MYQL <myql/>`_
- `StockScraper <stockscraper/>`_
- `YOAuth <oauth/>`_
- `Open Table <table/>`_
- `Contribute <contrib/>`_

  ** ` <.>`_

- `Docs <.>`_ »
- Home
- `Edit on GitHub <https://github.com/josuebrunel/myql>`_

--------------

MYQL
mYQL
====

MYQL is a Python wrapper of the Yahoo Query Language.
mYQL is a Python wrapper of the Yahoo Query Language. Read the full Documentation `Here <http://myql.readthedocs.org/en/latest/>`

Yahoo! Query Language Documentation and Support
===============================================

- `Yahoo! Query Language <http://developer.yahoo.com/yql/>`_
- `Yahoo! Developer Network <http://developer.yahoo.com>`_
- `Yahoo! Application Platform <http://developer.yahoo.com/yap/>`_
- `Yahoo! Social APIs <http://developer.yahoo.com/social/>`_
- `Yahoo! Query Language <http://developer.yahoo.com/yql/>`__
- `Yahoo! Developer Network <http://developer.yahoo.com>`__
- `Yahoo! Application Platform <http://developer.yahoo.com/yap/>`__
- `Yahoo! Social APIs <http://developer.yahoo.com/social/>`__
- `Yahoo! Query Language
Console <https://developer.yahoo.com/yql/console/>`_
Console <https://developer.yahoo.com/yql/console/>`__

Installation
============
Expand All @@ -36,16 +20,6 @@ Installation

$ pip install myql

::

$ pip install git+https://github.com/josuebrunel/myql.git

Or download the package and run

::

$ python setup.py install --record files_path.txt

Quick Start
===========

Expand Down Expand Up @@ -247,12 +221,12 @@ Using OAuth to fetch protected resources
>>> yql = MYQL(format='xml', oauth=oauth)
>>> response = yql.getGUID('josue_brunel') # Deal with the response

` <myql/>`_\ Next
` <myql/>`__\ Next

--------------

Built with `MkDocs <http://www.mkdocs.org>`_ using a
`theme <https://github.com/snide/sphinx_rtd_theme>`_ provided by `Read
the Docs <https://readthedocs.org>`_.
Built with `MkDocs <http://www.mkdocs.org>`__ using a
`theme <https://github.com/snide/sphinx_rtd_theme>`__ provided by `Read
the Docs <https://readthedocs.org>`__.

GitHub `« Previous <>`_ `Next » <myql/>`_
GitHub `« Previous <>`__ `Next » <myql/>`__
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ def read(fname):
return open(os.path.join(os.path.dirname(__file__), fname)).read()

setup(
name = "mYQL",
name = "myql",
version = __version__,
description = "Python Wrapper for the Yahoo! Query Language. Allowing to run YQL queries, fetch financial data and create YQL Open Tables",
long_description = read("README.rst"),
Expand Down

0 comments on commit 690e8ec

Please sign in to comment.