git.iko.soy/urbit.org
on 4fdc19d help sign in
urbit.org/content/grants/urbit-http-api-for-python.md
46 lines 1.6 kB history raw
1+++
2title = "Urbit HTTP API for Python"
3date = "2021-06-21"
5[taxonomies]
6grant_type = [ "Proposal" ]
7grant_category = [ "App Dev: Other" ]
9[extra]
10image = ""
11description = "Write an Urbit HTTP API (aka airlock) for Python"
12reward = "1 star"
13assignee = "novbyr-miclux"
14id = "P0029"
15completed = false
16canceled = false
17link = ""
18+++
20## Vision
22This proposed project will produce an API in Python language to interact with Urbit ship over HTTP with these [guidelines][airlock_requirements_link] in mind.
24[airlock_requirements_link]: https://docs.google.com/document/d/1no5oos_NE8LrUWz7iG9SKZMTIzruZVevZQ75nD5OHmI/edit
26## Design
281. Basic HTTP Interface: Building a mechanism for sending and receiving JSON to/from an Urbit ship. The features in urlock-py will be integrated into this repository.
292. Graph Store Interface: Interaface to graph-store Urbit API.
303. Additional Agent Interfaces: Interface to the group-store and contact-store Gall agent.
32This will be done using the structure of [urbit http java api][urbit_http_api_java_link]
34[urbit_http_api_java_link]: https://github.com/ynx0/airlock
36## Me
38I have been programming in Python for 5+ years now. I have used Python for a wide range of tasks like scientific computing, machine learning, batch scripting etc. I am currently in the 4th year of my PhD program. I am also a contributor to an open source Python project UQpy as part of my PhD.
40## Milestones
42### Complete the API
441 star
46A Github repository of the Python API complete with the proposed features, installation guide(README) will be developed and released.