Mailman 3 March 2021 - Twisted

[Twisted-Python] Developer docs should be updated on wiki when steps changed in code?
by Craig Rodrigues 04 Mar '21

04 Mar '21

In this PR: https://github.com/twisted/twisted/pull/1461 some changes were made to the Twisted development process for running the various linters before committing code. I noticed that the changes in PR 1461 were not reflected in docs on the wiki, specifically here: https://twistedmatrix.com/trac/wiki/TwistedDevelopment which mentions tox environments that have been deleted in PR 1461. I noticed this, when I recently tried to work on a branch from recent trunk, and when I tried to run some of the commands on that wiki page they didn't work, because they were deleted. In this post-review comment: https://github.com/twisted/twisted/pull/1461#issuecomment-753695414 I asked Thomas if he could modify the wiki to reflect the changes he made in trunk, but this hasn't been done yet. My impression in the comments in PR 1461 is that Thomas and Adi want to move all this documentation into the source tree, and delete the stuff on the wiki? Is this the long term plan? Until this is fully completed, what is the correct thing to do when there is a mismatch between docs on the wiki, and docs in the tree? I still refer to a lot of docs on the wiki, especially for process related things, so I think it would be nice if the wiki docs were kept up to date, until the day that they are fully deleted. -- Craig

3 4

[Twisted-Python] Twisted 21.2.0 Release Announcement
by Craig Rodrigues 04 Mar '21

04 Mar '21

On behalf of Twisted Matrix Laboratories, I am honored to announce the release of Twisted 21.2.0! There are two major announcements for this release: - *Python 2.7 support has been dropped*. Twisted 21.2.0 supports Python 3.5.3 and higher only - *This will be the last Twisted release to support Python 3.5*. Twisted 21.2.0 brings the following: - twist dns --pyzone now works on Python 3 - twisted.web.twcgi now works on Python 3 - all tests pass on all platforms on Python 3.8, including asyncio tests on Windows - tests pass on Python 3.9 (thanks to Michał Górny) - type hints, as specified in PEP 484, are now used in functions throughout the codebase - mypy (static type checker) is now run over the codebase during CI to help detect problems, and help improve the use of types - code in is now formatted with Black (thanks to Tom Most) - many CI and automation improvements (thanks to Adi Roiban and Thomas Grainger) - many more fixes (225 tickets closed!) You can install by running this command: python -m pip install Twisted==21.2.0 The full tarball is available at: https://pypi.org/project/Twisted/21.2.0/#files The full NEWS file with all changes is at: https://github.com/twisted/twisted/blob/twisted-21.2.0/NEWS.rst

5 6

Re: [Twisted-Python] Release blocker: Use latest pydoctor release ?
by Craig Rodrigues 04 Mar '21

04 Mar '21

Thanks for the clarification. You have provided a lot of useful details. There are a lot of interconnected pieces, with multiple people working on different things. For now, I am going to proceed to finish the release as-is. The documentation may not be automatically deployed as part of the release, but I think that can be done as a follow-on task. -- Craig On Sat, Feb 27, 2021 at 4:53 PM Adi Roiban <adiroiban(a)gmail.com> wrote: > Hi, > > Sorry for the delay. > > We did the automation and Read The Docs hosting. > > In parallel there was also the work required to host the pydoctor API docs > on Read The Docs. > > ---------- > > Note that https://docs.twistedmatrix.com/en/twisted-20.3.0/api 404 > > That should host the files from > https://twistedmatrix.com/documents/current/api/ > > --------- > > For `trunk` we have https://docs.twistedmatrix.com/en/latest/api/ > > That was the hard work done by Maarten to improve pydoctor and Twisted API > docs. > > ------------- > > There was a plan to do a new pydoctor release over the end of the year > break... but that never happened. > > The current PR that is "breaking" API links from narrative docs to API > docs on Read The Docs version of Twisted docs is > https://github.com/twisted/twisted/pull/1496 > > But even before that PR the API docs on Read the Docs were broken, as we > had too many HTML pages and the build process on RTD > was interrupted. > > This is why I have approved the PR in the first place. > > So https://github.com/twisted/twisted/pull/1466 should also be reverted > > ------------ > > So, if for this release the "official" Twisted documentation is to be > hosted at https://twistedmatrix.com/documents/current/api/ > then https://twistedmatrix.com/trac/ticket/10068 is not a blocker. > > If the plan is to host the full and "official" Twisted documentation on > Read The Docs, the https://twistedmatrix.com/trac/ticket/10068 is a > blocker. > > And the easiest solution is to do a new pydoctor release. > > ---------- > > I will try to follow up with Maarten over IRC to see if we can get a new > pydoctor release. > > In theory, the pydoctor release process is automated and any other Twisted > developer from https://github.com/orgs/twisted/teams/twisted-contributors > could do a release. > > Maarten did the release work in the recent past but if he is busy, in > theory anyone could step in and help with a new pydoctor release. > > Regards > > On Sat, 20 Feb 2021 at 17:47, Craig Rodrigues <rodrigc(a)crodrigues.org> > wrote: > >> Hi, >> >> I am confused. I thought that you and Thomas Graingert had completed all >> the automation and had changed the Twisted release scripts to host the >> documentation on readthedocs and that was all in place right now. >> >> Is that not the case? >> >> How much more work is necessary to completely host the next Twisted >> release's docs on readthedocs? >> >> -- >> Craig >> >> On Saturday, February 20, 2021, Adi Roiban <adiroiban(a)gmail.com> wrote: >> >>> Hi, >>> >>> Sorry for the delay. >>> >>> This was added as a blocker due to the changes from >>> https://github.com/twisted/twisted/pull/1496 and the plan to use Read >>> The Docs to >>> host the official docs. >>> >>> This is not a blocker if the official documentation for this release >>> will continue to be hosted on the Twisted own server at >>> https://twistedmatrix.com/documents/current/ >>> >>> It's a blocker only if the official documentation is to be hosted on >>> Read The Docs at docs.twistedmatrix.com >>> >>> I have updated the ticket to no longer block the release. >>> >>> Cheers >>> >>> >>> On Sat, 20 Feb 2021 at 02:08, Craig Rodrigues <rodrigc(a)crodrigues.org> >>> wrote: >>> >>>> Adi, >>>> >>>> Is there anything to be done here, or is this still a release blocker? >>>> >>>> -- >>>> Craig >>>> >>>> >>>> On Sun, Feb 14, 2021 at 4:15 PM Craig Rodrigues <rodrigc(a)crodrigues.org> >>>> wrote: >>>> >>>>> Hi, >>>>> >>>>> This ticket: Use latest pydoctor release, >>>>> https://twistedmatrix.com/trac/ticket/10068 >>>>> >>>>> is marked as a release blocker. >>>>> >>>>> Has that been resolved or is there more work that needs to be done to >>>>> fix that? >>>>> >>>>> -- >>>>> Craig >>>>> >>>> >>> >>> -- >>> Adi Roiban >>> >> > > -- > Adi Roiban >

2 7

Twisted March 2021