Add ability to update static URLs
[debian/godebian-client.git] / README
1 Example json-rpc client for deb.li/go.debian.net
2 ------------------------------------------------
3
4 Requirements:
5 -------------
6 Either python-anyjson and one supported json implementation, like python-cjson
7 or python-json.
8
9
10 Adding an URL:
11 --------------
12     % ./add_url http://bzed.de
13     bjlx
14
15 Now http://deb.li/bjlx and http://go.debian.net/bjlx will redirect
16 to http://bzed.de and http://deb.li/p/bjlx / http://go.debian.net/p/bjlx
17 will show a preview page of the redirect.
18
19
20
21 Adding a static URL:
22 -------------------
23 This function allows to select the key to use:
24
25     % ./add_static_url http://www.debian.org debian
26     debian
27
28 Now http://deb.li/debian and http://go.debian.net/debian will redirect
29 to http://www.debian.org and http://deb.li/p/debian / http://go.debian.net/p/debian
30 will show a preview page of the redirect.
31
32
33 In case the selected key is already used, an exception is raised:
34
35     % ./add_static_url http://www.google.de bjlx
36     <class 'godebian.manage.AddStaticUrlException'>:The custom alias you've chosen is not available or too long. We've created a random one for you instead, but you can try assigning a different custom alias again.
37
38     Kqx4
39
40
41
42 Requesting the URL by key:
43 --------------------------
44     % ./get_url Kqx4
45     http://www.google.de
46
47
48