Opened 3 years ago

Last modified 3 years ago

#7541 task new

Add official windows development documentation

Reported by: Richard Wall Owned by: Matt Jones
Priority: normal Milestone:
Component: core Keywords: documentation easy
Cc: Branch: branches/windows-development-docs-7541
branch-diff, diff-cov, branch-cov, buildbot
Author: rwall

Description

Change History (6)

comment:1 Changed 3 years ago by Matt Jones

Keywords: review added

Pull request here for new docs. https://github.com/twisted/twisted/pull/42

comment:2 Changed 3 years ago by Richard Wall

Author: rwall
Branch: branches/windows-development-docs-7541

(In [42903]) Branching to windows-development-docs-7541.

comment:3 Changed 3 years ago by Glyph

Owner: set to Matt Jones

Thanks for putting this into a branch for easy reading, rwall :).

Thank you very much amattjones for your contribution. We really need more Windows people actively contributing and I would be thrilled if you would stick around :-).

There are a couple of minor issues with this though.

  1. I'd really like to recommend the use of virtualenvs. That's how pretty much all Twisted developers do development on other platforms. However, pywin32 makes that a non-starter if you don't have visual c++ express professional 2008. It would be good to explain this caveat, and to explain that you really want to install professional if you can, and that you really need to install 32-bit Python if you can't.
  2. Since pip is already required by this tutorial, pip install -e . is a bit better than python setup.py develop. I think that it might even address the problem where trial doesn't have an extension and therefore can't be run by the normal cmd prompt?
  3. Don't advise people to run the tests in the bin directory, please. That's a bad habit that will cause problems. Better is to run the tests in some temporary location, although that may require setting up a %PATHEXT%. I would be interested to hear if this is possible without Combinator's bizarre shenanigans - we can also just fix the code to use setuptools entrypoints for the scripts, or explicitly give them a .py extension on Windows if it would simplify the documentation.
  4. Maybe distinguish between getting Twisted for development of Twisted on Windows, versus development of your own application? The guidance about how to set up your particular install is a bit different (i.e.: install a release version, just pip install Twisted).
  5. "get the source like you do on Linux" should be a link to something.
  6. There are some related tickets: #3238 #3696, and you may want to mention them. (You may not. Let me know if you think that mentioning that work in progress would be helpful).
  7. This document is something that's going to need to change every time the windows deployment story changes, and that will happen (and improve) when tickets like the ones I just mentioned land. Any idea how to encourage this particular documentation to be updated? How will developers notice that it needs to be updated when installation steps change on a platform they probably don't use?

Thanks again. I think this is really important and I would very much like to see it land.

comment:4 Changed 3 years ago by Glyph

Keywords: review removed

comment:5 Changed 3 years ago by khorn

FYI, pywin32 _can_ be installed into a virtualenv, just not with pip. You have to use easy_install, e.g.:

>easy_install -Z pywin32.executable.installer.file.exe

it's not pretty, but it works.

More difficult are PyCrypto and PyOpenSSL in a virtualenv (which I've been having trouble with lately). Will post details if and when I figure them out.

Note: See TracTickets for help on using tickets.