on master help sign in
Urbit HTTP API (Airlock) in Python proposal (#654)

* added urbit-http-api-for-python.md file * minor changes to urbit-http-api-for-python.md file * fix grant type * add space Co-authored-by: Josh Lehman <josh@urbit.org>

commit1005eed5964a1aa3a828ed5193f70f568f99f938 authorLohit Vandanapu <lohitvandanapu@gmail.com> dateWed 28 Jul 2021, 22:50 (5 years ago) parent785c85a
1 file changed+45
content/grants/proposals/urbit-http-api-for-python.md+45
content/grants/proposals/urbit-http-api-for-python.mdnew file+45
@@ -0,0 +1,45 @@
1++++
2+title = "Urbit HTTP API for Python"
3+date = 2021-06-22
4+[taxonomies]
5+grant_type = ["Proposal"]
6+grant_category = ["App Dev: Other"]
7+[extra]
8+image = ""
9+description = "Write an Urbit HTTP API (aka airlock) for Python"
10+reward = 1
11+assignee = "novbyr-miclux"
12+id = "P0029"
13+completed = false
14+link = ""
15++++
16+
17+## Vision
18+
19+This proposed project will produce an API in Python language to interact with Urbit ship over HTTP with these [guidelines][airlock_requirements_link] in mind.
20+
21+[airlock_requirements_link]: https://docs.google.com/document/d/1no5oos_NE8LrUWz7iG9SKZMTIzruZVevZQ75nD5OHmI/edit
22+
23+## Design
24+
25+1. 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.
26+2. Graph Store Interface: Interaface to graph-store Urbit API.
27+3. Additional Agent Interfaces: Interface to the group-store and contact-store Gall agent.
28+
29+This will be done using the structure of [urbit http java api][urbit_http_api_java_link]
30+
31+[urbit_http_api_java_link]: https://github.com/ynx0/airlock
32+
33+## Me
34+
35+I 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.
36+
37+
38+## Milestones
39+
40+### Complete the API
41+1 star
42+
43+A Github repository of the Python API complete with the proposed features, installation guide(README) will be developed and released.
44+
45+