A Pythonic Fleep API Client
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
fleepy
.gitignore
.travis.yml
LICENSE
README.md
requirements-dev.txt
requirements.txt
setup.py
tests.py
tox.ini

README.md

Fleepy - A Pythonic Fleep API Client

Build Status

Overview

I would like to thank the University of Tartu and the BIIT Research Group for allowing me to publish this as an open-source library.

This is an alpha client for the Fleep API. It is compatible with Python 2.7 and 3.

As of now it is a non-opinionated library. It makes a request and returns to you always a Response object.

Response is simply a namedtuple. In that you can access attributes status_code, data, headers and cookies. So any method you call we are not wrapping it in anything but a Response.

Installation

Via PIP

pip install fleepy

Manual

git clone https://github.com/nicholasamorim/fleepy.git
python setup.py install

So far it has two dependencies, namely Requests and attrdict. I am planning to remove Requests in the near future.

Goal

The main goal of this client was to reflect the API as accurate as possible while keeping it Pythonic enough. The main thing to observe is that every slash that you see in the address of the resource you want to use, you translate that to a dot.

A couple examples:

from fleepy import Fleepy

api = Fleepy()

# /account/login
api.account.login("one@email.com", "twopassword")

# /conversation/create
api.conversation.create(topic, emails, message)

# /account/export/start
api.account.export.start()

# /search
api.search(["A", "few", "keywords"])

# /search/prepare
api.search.prepare()

# /account/logout
api.account.logout()

Whenever Fleep API requests you for a "list" of something (usually space or comma delimited), just use a normal Python list, the library will do what Fleep wants behind the scenes.

Examples

Creating a chat room with topic and an initial message.

The example below logins, creates a chat room with three people and sends a message. The message uses some of Fleep styling features, check them out here.

from fleepy import Fleepy

api = Fleepy()
api.account.login("your@email.com", "yourpassword")


api.conversation.create(
    topic='This is a Room Topic',
    emails=['your@email.com', 'guest1@email.com', 'guest2@email.com'],
    message="""*Hello*, everyone!

    Something has just been posted in our Issue tracker.

    http://issue.tracker.com<<Go To Issue>>
    """)

api.account.logout()
File upload
from fleepy import Fleepy

api = Fleepy()
api.account.login("your@email.com", "yourpassword")

api.file.upload('/path/to/afile.jpg')
api.account.logout()

More and proper documentation to come.

To-Do:
  • Add more tests.
  • Implement the Info handler.
  • Create proper documentation.