forked from NiklasRosenstein/python-github-bot-api
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
237 lines (184 loc) · 8.4 KB
/
Copy pathindex.html
File metadata and controls
237 lines (184 loc) · 8.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="None">
<link rel="shortcut icon" href="img/favicon.ico">
<title>python-github-bot-api</title>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700" />
<link rel="stylesheet" href="css/theme.css" />
<link rel="stylesheet" href="css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "Home";
var mkdocs_page_input_path = "index.md";
var mkdocs_page_url = null;
</script>
<script src="js/jquery-2.1.1.min.js" defer></script>
<script src="js/modernizr-2.8.3.min.js" defer></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="." class="icon icon-home"> python-github-bot-api</a>
<div role="search">
<form id ="rtd-search-form" class="wy-form" action="./search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href=".">Home</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#quickstart-webhook">Quickstart (Webhook)</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#quickstart-application">Quickstart (Application)</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#combined-example">Combined Example</a>
</li>
</ul>
</li>
</ul>
<p class="caption"><span class="caption-text">API Documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="api-documentation/github_bot_api.app/">github_bot_api.app</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="api-documentation/github_bot_api.event/">github_bot_api.event</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="api-documentation/github_bot_api.flask/">github_bot_api.flask</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="api-documentation/github_bot_api.signature/">github_bot_api.signature</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="api-documentation/github_bot_api.token/">github_bot_api.token</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="api-documentation/github_bot_api.utils.mime/">github_bot_api.utils.mime</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="api-documentation/github_bot_api.utils.types/">github_bot_api.utils.types</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="api-documentation/github_bot_api.webhook/">github_bot_api.webhook</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href=".">python-github-bot-api</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href=".">Docs</a> »</li>
<li>Home</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/NiklasRosenstein/python-github-bot-api/edit/master/docs/index.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<h1 id="github-bot-api">github-bot-api</h1>
<p>API for creating GitHub bots and webhooks in Python.</p>
<blockquote>
<p>Note: If you want to make use of <code>GithubApp.client</code> or <code>GithubApp.installation_client()</code>, you
need to install <code>PyGithub</code>.</p>
</blockquote>
<h2 id="quickstart-webhook">Quickstart (Webhook)</h2>
<ol>
<li>Create a new Smee channel on https://smee.io</li>
<li>Install <code>smee-client</code> (e.g. <code>yarn global add smee-client</code>)</li>
<li>Run <code>smee -u <SMEE_CHANNEL_URL> -P /event-handler -p 5000</code></li>
<li>Create a Python script with the below contents and run it</li>
</ol>
<pre><code class="language-python">from github_bot_api import Event, Webhook
from github_bot_api.flask import create_flask_app
def on_any_event(event: Event) -> bool:
print(event)
return True
webhook = Webhook(secret=None)
webhook.listen('*', on_any_event)
import os; os.environ['FLASK_ENV'] = 'development'
flask_app = create_flask_app(__name__, webhook)
flask_app.run()
</code></pre>
<h2 id="quickstart-application">Quickstart (Application)</h2>
<ol>
<li>Create a GitHub App, including a private key</li>
<li>Set the <code>APP_ID</code> and <code>PRIVATE_KEY_FILE</code> environment variables</li>
<li>Run the following Python script</li>
</ol>
<pre><code class="language-python">import os
from github_bot_api import GithubApp
with open(os.environ['PRIVATE_KEY_FILE']) as fp:
private_key = fp.read()
app = GithubApp(
user_agent='my-bot/0.0.0',
app_id=int(os.environ['APP_ID']),
private_key=private_key)
print(app.client.get_app().owner)
</code></pre>
<h2 id="combined-example">Combined Example</h2>
<pre><code class="language-python"># ...
app = GithubApp(...)
webhook = Webhook()
@webhook.listen('pull_request')
def on_pull_request(event: Event) -> bool:
client = app.installation_client(event.payload['installation']['id'])
repo = client.get_repo(event['repository']['full_name'])
pr = repo.get_pull(event['pull_request']['number'])
pr.create_issue_comment('Hello from my own bot!')
return True
# ...
</code></pre>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="api-documentation/github_bot_api.app/" class="btn btn-neutral float-right" title="github_bot_api.app">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span>
<a href="https://github.com/NiklasRosenstein/python-github-bot-api/" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="api-documentation/github_bot_api.app/" style="color: #fcfcfc">Next »</a></span>
</span>
</div>
<script>var base_url = '.';</script>
<script src="js/theme_extra.js" defer></script>
<script src="js/theme.js" defer></script>
<script src="search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>
<!--
MkDocs version : 1.2.2
Build Date UTC : 2021-08-20 13:42:14.309402+00:00
-->