python-o365/docs/latest/getting_started.html at master · ldorner/python-o365 · GitHub

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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269


<!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 name="viewport" content="width=device-width, initial-scale=1.0">

  <title>Getting Started &mdash; O365  documentation</title>


  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="Detailed Usage" href="usage.html" />
    <link rel="prev" title="Welcome to O365’s documentation!" href="index.html" />


  <script src="_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav">


  <div class="wy-grid-for-nav">


    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search">


            <a href="index.html" class="icon icon-home"> O365


          </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" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>


        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">


              <p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Getting Started</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#installation">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="#oauth-setup-pre-requisite">OAuth Setup (Pre Requisite)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#basic-usage">Basic Usage</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="usage.html">Detailed Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="api.html">O365 API</a></li>
</ul>


        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">


      <nav class="wy-nav-top" aria-label="top navigation">

          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="index.html">O365</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="index.html">Docs</a> &raquo;</li>

      <li>Getting Started</li>


      <li class="wy-breadcrumbs-aside">


            <a href="_sources/getting_started.rst.txt" rel="nofollow"> View page source</a>


      </li>

  </ul>


  <div class="rst-breadcrumbs-buttons" role="navigation" aria-label="breadcrumb navigation">

        <a href="usage.html" class="btn btn-neutral float-right" title="Detailed Usage" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>


        <a href="index.html" class="btn btn-neutral" title="Welcome to O365’s documentation!" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>

  </div>

  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">

  <div class="section" id="getting-started">
<h1>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h1>
<div class="section" id="installation">
<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
<ul>
<li><dl>
<dt>Stable Version from Pypi</dt><dd><p><a class="reference external" href="https://pypi.org">https://pypi.org</a> has the latest stable package.</p>
<p>For installing the package using pip, run <code class="code docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">o365</span></code></p>
</dd>
</dl>
</li>
<li><dl>
<dt>Latest Development Version from Github</dt><dd><p>Github has the latest development version, which may have more features but could be unstable.
So <strong>Use as own risk</strong></p>
<p>For installing code from github, run <code class="code docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">git+https://github.com/O365/python-o365.git</span></code></p>
</dd>
</dl>
</li>
</ul>
</div>
<div class="section" id="oauth-setup-pre-requisite">
<h2>OAuth Setup (Pre Requisite)<a class="headerlink" href="#oauth-setup-pre-requisite" title="Permalink to this headline">¶</a></h2>
<p>You will need to register your application at <a class="reference external" href="https://apps.dev.microsoft.com/">Microsoft Apps</a>. Steps below</p>
<ol class="arabic simple">
<li><p>Login to <a class="reference external" href="https://apps.dev.microsoft.com/">https://apps.dev.microsoft.com/</a></p></li>
<li><p>Create an app, note your app id (<strong>client_id</strong>)</p></li>
<li><p>Generate a new password (<strong>client_secret</strong>) under <strong>Application Secrets</strong> section</p></li>
<li><p>Under the <strong>Platform</strong> section, add a new Web platform and set “<a class="reference external" href="https://outlook.office365.com/owa/">https://outlook.office365.com/owa/</a>” as the redirect URL</p></li>
<li><dl class="simple">
<dt>Under “Microsoft Graph Permissions” section, Add the below delegated permission (or based on what scopes you plan to use)</dt><dd><ol class="arabic simple">
<li><p>email</p></li>
<li><p>Mail.ReadWrite</p></li>
<li><p>Mail.Send</p></li>
<li><p>User.Read</p></li>
</ol>
</dd>
</dl>
</li>
<li><p>Note the <strong>client_id</strong> and <strong>client_secret</strong> as they will be using for establishing the connection through the api</p></li>
</ol>
</div>
<div class="section" id="basic-usage">
<h2>Basic Usage<a class="headerlink" href="#basic-usage" title="Permalink to this headline">¶</a></h2>
<p>Work in progress</p>
</div>
</div>


           </div>

          </div>
          <footer>

    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

        <a href="usage.html" class="btn btn-neutral float-right" title="Detailed Usage" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>


        <a href="index.html" class="btn btn-neutral" title="Welcome to O365’s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

    </div>


  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2018, Narcolapser

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.

</footer>

        </div>
      </div>

    </section>

  </div>


      <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
        <script src="_static/jquery.js"></script>
        <script src="_static/underscore.js"></script>
        <script src="_static/doctools.js"></script>
        <script src="_static/language_data.js"></script>


  <script type="text/javascript" src="_static/js/theme.js"></script>

  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

</body>
</html>