Skip to content

Commit

Permalink
#1 updating documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
josuebrunel committed Aug 24, 2014
1 parent cfc1c83 commit cade482
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 19 deletions.
39 changes: 20 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,10 @@ Yahoo! Query Langauge Documentation and Support
* Yahoo! Application Platform - http://developer.yahoo.com/yap/
* Yahoo! Social APIs - http://developer.yahoo.com/social/

version 0.5.1
version 0.5.2
=============
* fetch data
* access to community data
* select data format (xml/json)
* change data source
* filter data
Expand Down Expand Up @@ -60,17 +61,17 @@ access to community tables
Methods
-------

* use(data_provider_url)
------------------------------
use(data_provider_url)
-----------------------

Changes the data provider

```python
>>> yql.use('http://myserver.com/mytables.xml')
```

* desc(tablename)
-----------------------
desc(tablename)
---------------
returns table description

```python
Expand All @@ -80,8 +81,8 @@ Changes the data provider
>>>
```

* rawQuery(query)
-----------------------
rawQuery(query)
----------------

Allows you to directly type your query

Expand All @@ -90,8 +91,8 @@ Allows you to directly type your query
>>> # deal with the response
```

* select(table, fields, limit).where(filters, ...)
-------------------------------------------------
select(table, fields, limit).where(filters, ...)
------------------------------------------------

Select a table i.e *weather.forecast*.
If *table* not provided, it will use the default table. If there's no such thing as a default table, it will raise a *NoTableSelectedError*
Expand All @@ -113,8 +114,8 @@ If *table* not provided, it will use the default table. If there's no such thing
>>>
```

* get(table, fields, limit)
----------------------------------
get(table, fields, limit)
--------------------------

Same as ***SELECT***, but instead returns data.

Expand All @@ -126,17 +127,17 @@ Same as ***SELECT***, but instead returns data.
```


* create()
----------
create()
---------

* insert()
----------
insert()
---------

* update()
----------
update()
--------

* delete()
----------
delete()
---------



Expand Down
1 change: 1 addition & 0 deletions lokingyql/lokingyql.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

class LokingYQL(object):
'''Yet another Python Yahoo! Query Language Wrapper
'''
default_url = 'https://query.yahooapis.com/v1/public/yql'
community_data = "env 'store://datatables.org/alltableswithkeys'; " #Access to community table
Expand Down

0 comments on commit cade482

Please sign in to comment.