DESCRIPTION.rst 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899
  1. # pywin32
  2. [![CI](https://github.com/mhammond/pywin32/workflows/CI/badge.svg)](https://github.com/mhammond/pywin32/actions?query=workflow%3ACI)
  3. [![PyPI - Version](https://img.shields.io/pypi/v/pywin32.svg)](https://pypi.org/project/pywin32)
  4. [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pywin32.svg)](https://pypi.org/project/pywin32)
  5. [![PyPI - Downloads](https://img.shields.io/pypi/dm/pywin32.svg)](https://pypi.org/project/pywin32)
  6. [![License - PSF-2.0](https://img.shields.io/badge/license-PSF--2.0-9400d3.svg)](https://spdx.org/licenses/PSF-2.0.html)
  7. -----
  8. This is the readme for the Python for Win32 (pywin32) extensions, which provides access to many of the Windows APIs from Python.
  9. See [CHANGES.txt](https://github.com/mhammond/pywin32/blob/master/CHANGES.txt) for recent notable changes.
  10. Build 228 is the last build supporting Python 2, and as part of this transition,
  11. all code in the repository is now using Python 3 syntax.
  12. To highlight and celebrate this change, build 228 is the last numbered 2XX - the
  13. following build numbers start at 300.
  14. In other words, there is no build 229 - the build numbers jump from 228 to 300.
  15. As of build 222, pywin32 has a new home at [github](https://github.com/mhammond/pywin32).
  16. You can find build 221 and later on github and older versions can be found on
  17. the old project home at [sourceforge](https://sourceforge.net/projects/pywin32/)
  18. A special shout-out to @xoviat who provided enormous help with the github move!
  19. ## Support
  20. Feel free to [open issues](https://github.com/mhammond/pywin32/issues) for
  21. all bugs (or suspected bugs) in pywin32. [pull-requests](https://github.com/mhammond/pywin32/pulls)
  22. for all bugs or features are also welcome.
  23. However, please **do not open github issues for general support requests**, or
  24. for problems or questions using the modules in this package - they will be
  25. closed. For such issues, please email the
  26. [python-win32 mailing list](http://mail.python.org/mailman/listinfo/python-win32) -
  27. note that you must be subscribed to the list before posting.
  28. ## Binaries
  29. By far the easiest way to use pywin32 is to grab binaries from the [most recent release](https://github.com/mhammond/pywin32/releases)
  30. ## Installing via PIP
  31. You can install pywin32 via pip:
  32. > pip install pywin32
  33. Note that if you want to use pywin32 for "system wide" features, such as
  34. registering COM objects or implementing Windows Services, then you must run
  35. the following command from an elevated command prompt:
  36. > python Scripts/pywin32_postinstall.py -install
  37. ## Building from source
  38. Building from source has been simplified recently - you just need Visual Studio
  39. and the Windows 10 SDK installed (the free compilers probably work too, but
  40. haven't been tested - let me know your experiences!)
  41. `setup.py` is a standard distutils build script. You probably want:
  42. > python setup.py install
  43. or
  44. > python setup.py --help
  45. You can run `setup.py` without any arguments to see
  46. specific information about dependencies. A vanilla MSVC installation should
  47. be able to build most extensions and list any extensions that could not be
  48. built due to missing libraries - if the build actually fails with your
  49. configuration, please [open an issue](https://github.com/mhammond/pywin32/issues).
  50. ## Release process
  51. The following steps are performed when making a new release - this is mainly
  52. to form a checklist so mhammond doesn't forget what to do :)
  53. * Ensure CHANGES.txt has everything worth noting, commit it.
  54. * Update setup.py with the new build number.
  55. * Execute build.bat, wait forever, test the artifacts.
  56. * Commit setup.py (so the new build number is in the repo), create a new git tag
  57. * Update setup.py with the new build number + ".1" (eg, 123.1), to ensure
  58. future test builds aren't mistaken for the real release.
  59. * Make sure everything is pushed to github, including the tag (ie,
  60. `git push --tags`)
  61. * Upload the .exe installers to github (using the web UI), the .whl files to
  62. pypi (using `py -3.5 -m twine upload dist/*XXX*.whl` where `XXX` is the build
  63. number).
  64. * Send mail to python-win32