DISCLAIMER

Note: This project is discontinued. All code may still be re-used, but it wont be improved. I suggest you find indiviual libraries for your needs.

SocialLua

SocialLua is a set of modules designed to make it easy for you to use the APIs of internet sites and services with ease. It is managed by Linus Sjögren and Bart van Strien.
The code is licensed under the Public Domain.

Table of Contents:

1. Including SocialLua in your script
2. Return values
3. Contributing to the project
4. Module documentation

Including SocialLua in your Script

Using SocialLua is just a matter of requiring the modules you need.

require("social.twitter")
social.twitter.tweet("Hello World from SocialLua!", "username", "password")

The above example wont work atm, though. :(
Since SocialLua is Public Domain code, you may use it however you like, with no restrictions. This means that you don’t need to worry about licensing issues.

Return values

All SocialLua modules follows the standard (data or nil, error message) as return values.

data, err = social.twitter.homeTimeline("username", "password")
if data then
    -- do stuff with the data
else
    print("Error, "..err)
end

Contributing to the project

Contributing is as easy as forking the SocialLua repo and adding your own stuff.
There are some guidelines, though:

• Comment your code with LuaDoc-compatible documentation.
• Use return values as the rest of the project does.

Module documentation

The documentation is not available outside of the source code for now. You can look in the source code of the module that you want to use to see how to use it’s functions.

We are planning on making the GitHub page include auto-generated documentation. Meanwhile, the source code is your friend.