Metadata-Version: 2.1
Name: urlock
Version: 0.1.22
Summary: Library for talking to a running Urbit ship
Home-page: http://github.com/baudtack/urlock-py
Author: David Kerschner
Author-email: dkerschner@gmail.com
License: MIT
Keywords: urbit urlock
Platform: UNKNOWN
Description-Content-Type: text/markdown
Requires-Dist: requests
Requires-Dist: sseclient-py

# Urlock-py

Urlock-py is a python library for connecting to a running urbit ship.

It consists of a single class `Urlock`. Methods are below.

`__init__(url, code)`

    Constructor

    `url` - url to the http interface of the running ship

    `code` - the `+code` of the ship, should never be published


`connect()`

    Connect to the running ship


`poke(ship, app, mark, j)`

    `ship` - ship to send the poke

    `app` - gall application to send the poke to

    `mark` - mark of data sent to the gall application

    `j` - json poke data


`ack(eventId)`

    Send an acknowledgment of receipt of a message so it's cleared from the ship's queue 

    `eventId` - id of the event to acknowledge


`sse_pipe()`

    returns the sseclient object


`subscribe(ship, app, path)`

    `ship` - ship on which the gall application lives

    `app` - gall application to subscribe to

    `path` - path to subscribe on


Follows is a simple script to send a message and subscribe to a chat channel. The specifics require an understanding of the `chat-store` and `chat-hook` interfaces.

```
#!/usr/bin/python3

import urlock
import baseconvert
import time
import random
import dumper

zod = urlock.Urlock("http://localhost:8080", "lidlut-tabwed-pillex-ridrup")
r = zod.connect()
s = zod.subscribe("zod", "chat-store", "/mailbox/~/~zod/mc")

pipe = zod.sse_pipe()

s = baseconvert.base(random.getrandbits(128), 10, 32, string=True).lower()
uid = '0v' + '.'.join(s[i:i+5] for i in range(0, len(s), 5))[::-1]

p = zod.poke("zod", "chat-hook", "json", {"message": {"path": "/~/~zod/mc",
                                                      "envelope": {"uid": uid,
                                                                   "number": 1,
                                                                   "author": "~zod",
                                                                   "when": int(time.time() * 1000),
                                                                   "letter": {"text": "hello world!"}}}})


for m in pipe.events():
   dumper.dump(m)
   dumper.dump(zod.ack(int(m.id)))
```

