Skip to content

Commit e07d4db

Browse files
hakrilhakril
committed
Added th description from the readme at the beginning of the documentation
1 parent c848f33 commit e07d4db

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

74 files changed

+143
-81
lines changed

‎TODO

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ TODO:
22

33
- Better WMI interface
44

5+
- Process:
6+
- set/get WinProcess.priority
57

68
- DBG
79
- Verif multiple bp at same place..

‎docs/build/html/_modules/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ <h3>Navigation</h3>
112112
</div>
113113
<div class="footer" role="contentinfo">
114114
&#169; Copyright 2015, Clement Rouault.
115-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.5.
115+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
116116
</div>
117117
</body>
118118
</html>

‎docs/build/html/_modules/windows/alpc.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -623,7 +623,7 @@ <h3>Navigation</h3>
623623
</div>
624624
<div class="footer" role="contentinfo">
625625
&#169; Copyright 2015, Clement Rouault.
626-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.5.
626+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
627627
</div>
628628
</body>
629629
</html>

‎docs/build/html/_modules/windows/crypto/certificate.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -520,7 +520,7 @@ <h3>Navigation</h3>
520520
</div>
521521
<div class="footer" role="contentinfo">
522522
&#169; Copyright 2015, Clement Rouault.
523-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.5.
523+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
524524
</div>
525525
</body>
526526
</html>

‎docs/build/html/_modules/windows/crypto/encrypt_decrypt.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ <h3>Navigation</h3>
193193
</div>
194194
<div class="footer" role="contentinfo">
195195
&#169; Copyright 2015, Clement Rouault.
196-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.5.
196+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
197197
</div>
198198
</body>
199199
</html>

‎docs/build/html/_modules/windows/crypto/generation.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ <h3>Navigation</h3>
139139
</div>
140140
<div class="footer" role="contentinfo">
141141
&#169; Copyright 2015, Clement Rouault.
142-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.5.
142+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
143143
</div>
144144
</body>
145145
</html>

‎docs/build/html/_modules/windows/debug/breakpoints.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,7 @@ <h3>Navigation</h3>
268268
</div>
269269
<div class="footer" role="contentinfo">
270270
&#169; Copyright 2015, Clement Rouault.
271-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.5.
271+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
272272
</div>
273273
</body>
274274
</html>

‎docs/build/html/_modules/windows/debug/debugger.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1113,7 +1113,7 @@ <h3>Navigation</h3>
11131113
</div>
11141114
<div class="footer" role="contentinfo">
11151115
&#169; Copyright 2015, Clement Rouault.
1116-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.5.
1116+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
11171117
</div>
11181118
</body>
11191119
</html>

‎docs/build/html/_modules/windows/debug/localdbg.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -367,7 +367,7 @@ <h3>Navigation</h3>
367367
</div>
368368
<div class="footer" role="contentinfo">
369369
&#169; Copyright 2015, Clement Rouault.
370-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.5.
370+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
371371
</div>
372372
</body>
373373
</html>

‎docs/build/html/_modules/windows/generated_def/windef.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2027,7 +2027,7 @@ <h3>Navigation</h3>
20272027
</div>
20282028
<div class="footer" role="contentinfo">
20292029
&#169; Copyright 2015, Clement Rouault.
2030-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.5.
2030+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
20312031
</div>
20322032
</body>
20332033
</html>

‎docs/build/html/_modules/windows/generated_def/winstructs.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4428,7 +4428,7 @@ <h3>Navigation</h3>
44284428
</div>
44294429
<div class="footer" role="contentinfo">
44304430
&#169; Copyright 2015, Clement Rouault.
4431-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.5.
4431+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
44324432
</div>
44334433
</body>
44344434
</html>

‎docs/build/html/_modules/windows/hooks.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ <h3>Navigation</h3>
208208
</div>
209209
<div class="footer" role="contentinfo">
210210
&#169; Copyright 2015, Clement Rouault.
211-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.5.
211+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
212212
</div>
213213
</body>
214214
</html>

‎docs/build/html/_modules/windows/native_exec/cpuid.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@ <h3>Navigation</h3>
243243
</div>
244244
<div class="footer" role="contentinfo">
245245
&#169; Copyright 2015, Clement Rouault.
246-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.5.
246+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
247247
</div>
248248
</body>
249249
</html>

‎docs/build/html/_modules/windows/native_exec/native_function.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ <h3>Navigation</h3>
200200
</div>
201201
<div class="footer" role="contentinfo">
202202
&#169; Copyright 2015, Clement Rouault.
203-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.5.
203+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
204204
</div>
205205
</body>
206206
</html>

‎docs/build/html/_modules/windows/native_exec/simple_x86.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1134,7 +1134,7 @@ <h3>Navigation</h3>
11341134
</div>
11351135
<div class="footer" role="contentinfo">
11361136
&#169; Copyright 2015, Clement Rouault.
1137-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.5.
1137+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
11381138
</div>
11391139
</body>
11401140
</html>

‎docs/build/html/_modules/windows/pe_parse.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -824,7 +824,7 @@ <h3>Navigation</h3>
824824
</div>
825825
<div class="footer" role="contentinfo">
826826
&#169; Copyright 2015, Clement Rouault.
827-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.5.
827+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
828828
</div>
829829
</body>
830830
</html>

‎docs/build/html/_modules/windows/remotectypes.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -586,7 +586,7 @@ <h3>Navigation</h3>
586586
</div>
587587
<div class="footer" role="contentinfo">
588588
&#169; Copyright 2015, Clement Rouault.
589-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.5.
589+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
590590
</div>
591591
</body>
592592
</html>

‎docs/build/html/_modules/windows/rpc/client.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ <h3>Navigation</h3>
237237
</div>
238238
<div class="footer" role="contentinfo">
239239
&#169; Copyright 2015, Clement Rouault.
240-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.5.
240+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
241241
</div>
242242
</body>
243243
</html>

‎docs/build/html/_modules/windows/rpc/epmapper.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,7 @@ <h3>Navigation</h3>
281281
</div>
282282
<div class="footer" role="contentinfo">
283283
&#169; Copyright 2015, Clement Rouault.
284-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.5.
284+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
285285
</div>
286286
</body>
287287
</html>

‎docs/build/html/_modules/windows/rpc/ndr.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -503,7 +503,7 @@ <h3>Navigation</h3>
503503
</div>
504504
<div class="footer" role="contentinfo">
505505
&#169; Copyright 2015, Clement Rouault.
506-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.5.
506+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
507507
</div>
508508
</body>
509509
</html>

‎docs/build/html/_modules/windows/syswow64.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -398,7 +398,7 @@ <h3>Navigation</h3>
398398
</div>
399399
<div class="footer" role="contentinfo">
400400
&#169; Copyright 2015, Clement Rouault.
401-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.5.
401+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
402402
</div>
403403
</body>
404404
</html>

‎docs/build/html/_modules/windows/utils/winutils.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -411,7 +411,7 @@ <h3>Navigation</h3>
411411
</div>
412412
<div class="footer" role="contentinfo">
413413
&#169; Copyright 2015, Clement Rouault.
414-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.5.
414+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
415415
</div>
416416
</body>
417417
</html>

‎docs/build/html/_modules/windows/winobject/exception.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -459,7 +459,7 @@ <h3>Navigation</h3>
459459
</div>
460460
<div class="footer" role="contentinfo">
461461
&#169; Copyright 2015, Clement Rouault.
462-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.5.
462+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
463463
</div>
464464
</body>
465465
</html>

‎docs/build/html/_modules/windows/winobject/handle.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ <h3>Navigation</h3>
223223
</div>
224224
<div class="footer" role="contentinfo">
225225
&#169; Copyright 2015, Clement Rouault.
226-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.5.
226+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
227227
</div>
228228
</body>
229229
</html>

‎docs/build/html/_modules/windows/winobject/network.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -531,7 +531,7 @@ <h3>Navigation</h3>
531531
</div>
532532
<div class="footer" role="contentinfo">
533533
&#169; Copyright 2015, Clement Rouault.
534-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.5.
534+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
535535
</div>
536536
</body>
537537
</html>

‎docs/build/html/_modules/windows/winobject/process.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1608,7 +1608,7 @@ <h3>Navigation</h3>
16081608
</div>
16091609
<div class="footer" role="contentinfo">
16101610
&#169; Copyright 2015, Clement Rouault.
1611-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.5.
1611+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
16121612
</div>
16131613
</body>
16141614
</html>

‎docs/build/html/_modules/windows/winobject/registry.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,7 @@ <h3>Navigation</h3>
268268
</div>
269269
<div class="footer" role="contentinfo">
270270
&#169; Copyright 2015, Clement Rouault.
271-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.5.
271+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
272272
</div>
273273
</body>
274274
</html>

‎docs/build/html/_modules/windows/winobject/service.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ <h3>Navigation</h3>
219219
</div>
220220
<div class="footer" role="contentinfo">
221221
&#169; Copyright 2015, Clement Rouault.
222-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.5.
222+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
223223
</div>
224224
</body>
225225
</html>

‎docs/build/html/_modules/windows/winobject/system.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -367,7 +367,7 @@ <h3>Navigation</h3>
367367
</div>
368368
<div class="footer" role="contentinfo">
369369
&#169; Copyright 2015, Clement Rouault.
370-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.5.
370+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
371371
</div>
372372
</body>
373373
</html>

‎docs/build/html/_modules/windows/winobject/volume.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ <h3>Navigation</h3>
155155
</div>
156156
<div class="footer" role="contentinfo">
157157
&#169; Copyright 2015, Clement Rouault.
158-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.5.
158+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
159159
</div>
160160
</body>
161161
</html>

‎docs/build/html/_modules/windows/winobject/wmi.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -64,11 +64,11 @@ <h1>Source code for windows.winobject.wmi</h1><div class="highlight"><pre>
6464
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;An object to perform wmi request to ``root\cimv2``&quot;&quot;&quot;</span>
6565
<span class="n">INSTANCE</span> <span class="o">=</span> <span class="kc">None</span>
6666

67-
<span class="k">def</span> <span class="nf">__new__</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
68-
<span class="k">if</span> <span class="bp">cls</span><span class="o">.</span><span class="n">INSTANCE</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
69-
<span class="k">return</span> <span class="bp">cls</span><span class="o">.</span><span class="n">INSTANCE</span>
70-
<span class="bp">cls</span><span class="o">.</span><span class="n">INSTANCE</span> <span class="o">=</span> <span class="nb">super</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="bp">cls</span><span class="p">)</span><span class="o">.</span><span class="fm">__new__</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
71-
<span class="k">return</span> <span class="bp">cls</span><span class="o">.</span><span class="n">INSTANCE</span>
67+
<span class="c1"># def __new__(cls, *args, **kwargs):</span>
68+
<span class="c1"># if cls.INSTANCE is not None:</span>
69+
<span class="c1"># return cls.INSTANCE</span>
70+
<span class="c1"># cls.INSTANCE = super(cls, cls).__new__(cls, *args, **kwargs)</span>
71+
<span class="c1"># return cls.INSTANCE</span>
7272

7373
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">target</span><span class="o">=</span><span class="s2">&quot;root</span><span class="se">\\</span><span class="s2">cimv2&quot;</span><span class="p">,</span> <span class="n">user</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">password</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
7474
<span class="n">locator</span> <span class="o">=</span> <span class="n">IWbemLocator</span><span class="p">()</span>
@@ -173,7 +173,7 @@ <h3>Navigation</h3>
173173
</div>
174174
<div class="footer" role="contentinfo">
175175
&#169; Copyright 2015, Clement Rouault.
176-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.5.
176+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
177177
</div>
178178
</body>
179179
</html>

‎docs/build/html/_modules/windows/wintrust.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,7 @@ <h3>Navigation</h3>
282282
</div>
283283
<div class="footer" role="contentinfo">
284284
&#169; Copyright 2015, Clement Rouault.
285-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.5.
285+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
286286
</div>
287287
</body>
288288
</html>

‎docs/build/html/_sources/index.rst.txt

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,25 @@
66
Welcome to PythonForWindows's documentation!
77
============================================
88

9-
Contents:
9+
Description
10+
"""""""""""
11+
12+
PythonForWindows is a base of code aimed to make interaction with ``Windows`` (on X86/X64) easier (for both 32 and 64 bits Python).
13+
Its goal is to offer abstractions around some of the OS features in a (I hope) pythonic way.
14+
It also tries to make the barrier between python and native execution thinner in both ways.
15+
There is no external dependencies but it relies heavily on the ``ctypes`` module.
16+
17+
18+
Some of this code is clean (IMHO) and some parts are just a wreck that works for now.
19+
Let's say that the codebase evolves with my needs and my curiosity.
20+
21+
If you have any issue, question, suggestion do not hesitate to contact me.
22+
I am always glad to have feedbacks from people using this project.
23+
24+
Examples are available on the `github page <https://github.com/hakril/pythonforwindows#pythonforwindows>`_ and in the :ref:`sample_of_code`.
25+
26+
Documentation
27+
"""""""""""""
1028

1129
.. toctree::
1230
:maxdepth: 2

‎docs/build/html/_sources/sample.rst.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
2+
.. _sample_of_code:
3+
14
Samples of code
25
===============
36

‎docs/build/html/_static/basic.css

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
*
55
* Sphinx stylesheet -- basic theme.
66
*
7-
* :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS.
7+
* :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
88
* :license: BSD, see LICENSE for details.
99
*
1010
*/

‎docs/build/html/_static/classic.css

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
*
55
* Sphinx stylesheet -- classic theme.
66
*
7-
* :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS.
7+
* :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
88
* :license: BSD, see LICENSE for details.
99
*
1010
*/

‎docs/build/html/_static/doctools.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
*
55
* Sphinx JavaScript utilities for all documentation.
66
*
7-
* :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS.
7+
* :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
88
* :license: BSD, see LICENSE for details.
99
*
1010
*/

0 commit comments

Comments
 (0)