add skeleton for variant type support
[pywinlite.git] / README
blob45c5149fcccc0f1b340c510766fd189548e07938
1 Pywinlite is a set of bindings for the Windows API written in pure Python.
3 As of right now, it's very incomplete; I am hoping it will become more complete
4 as I start to use it (and, of course, implement the things I need).
6 If this project is useful or potentially useful to you, drop me a line. I'm
7 currently going by the assumption that no one much cares except me.
9 I'm working based on these guidelines:
10 * Try to put logical groups of constants, types, and functions in a single
11     module. MSDN is often a good guide for this but is not perfect.
12 * Export functions similar to those used in the C API. If it's easy, raise
13     exceptions when errors occur and transform out parameters into return
14     values.
15 * Wrap ANSI/Unicode functions generically so that one or the other can be
16     selected at runtime. As of right now, this selection can be made one time
17     at the start of a program, and it defaults to Unicode (no automatic ANSI
18     fall-back just yet). ANSI functions can be used by calling
19     winlitecfg.set_ansi(). Do not export A- or W-suffixed functions.
20 * If the API can be made less awkward by wrapping things in a Python type, do
21     it. Otherwise, don't. Windows are wrapped (because making window classes can
22     be awkward), but cursors are not.
23 * Release things even if they are only slightly useful, and mark the bits that
24     are incomplete.
26 Enjoy.
28 Vincent Povirk
29 madewokherd@gmail.com