From mike at pythonlibrary.org Wed Feb 19 16:56:40 2014 From: mike at pythonlibrary.org (Mike Driscoll) Date: Wed, 19 Feb 2014 09:56:40 -0600 Subject: [Python-authors] Python 101 - the book Message-ID: Hi, I've mentioned I'm working on a book on this list a few times. Well I've gotten over a dozen chapters written and I've started a Kickstarter for the project that I thought I'd share: http://kck.st/1kX98BB Authoring a book is a lot of fun and a lot of work. Thanks for all the help you all have given me! Mike P.S. I may ask more questions later! -------------- next part -------------- An HTML attachment was scrubbed... URL: From doug at doughellmann.com Sat Feb 22 16:55:23 2014 From: doug at doughellmann.com (Doug Hellmann) Date: Sat, 22 Feb 2014 10:55:23 -0500 Subject: [Python-authors] Python 101 - the book In-Reply-To: References: Message-ID: <9062A87B-8811-448F-9262-4A52A9DFB715@doughellmann.com> What a great idea! I hope you?ll blog about your progress. Doug On Feb 19, 2014, at 10:56 AM, Mike Driscoll wrote: > Hi, > > I've mentioned I'm working on a book on this list a few times. Well I've gotten over a dozen chapters written and I've started a Kickstarter for the project that I thought I'd share: > > http://kck.st/1kX98BB > > Authoring a book is a lot of fun and a lot of work. Thanks for all the help you all have given me! > > Mike > > P.S. I may ask more questions later! > _______________________________________________ > Python-authors mailing list > Python-authors at python.org > https://mail.python.org/mailman/listinfo/python-authors -------------- next part -------------- An HTML attachment was scrubbed... URL: From mike at pythonlibrary.org Sat Feb 22 18:10:09 2014 From: mike at pythonlibrary.org (Mike Driscoll) Date: Sat, 22 Feb 2014 11:10:09 -0600 Subject: [Python-authors] Python 101 - the book In-Reply-To: <9062A87B-8811-448F-9262-4A52A9DFB715@doughellmann.com> References: <9062A87B-8811-448F-9262-4A52A9DFB715@doughellmann.com> Message-ID: Hi Doug, I'm not only going to blog about the progress, but also about the process itself. There isn't enough information out there about how to write books using Python tools. - Mike On Sat, Feb 22, 2014 at 9:55 AM, Doug Hellmann wrote: > What a great idea! I hope you'll blog about your progress. > > Doug > > On Feb 19, 2014, at 10:56 AM, Mike Driscoll > wrote: > > Hi, > > I've mentioned I'm working on a book on this list a few times. Well I've > gotten over a dozen chapters written and I've started a Kickstarter for the > project that I thought I'd share: > > http://kck.st/1kX98BB > > Authoring a book is a lot of fun and a lot of work. Thanks for all the > help you all have given me! > > Mike > > P.S. I may ask more questions later! > _______________________________________________ > Python-authors mailing list > Python-authors at python.org > https://mail.python.org/mailman/listinfo/python-authors > > > > _______________________________________________ > Python-authors mailing list > Python-authors at python.org > https://mail.python.org/mailman/listinfo/python-authors > > -- ----------------- Mike Driscoll Blog: http://blog.pythonlibrary.org -------------- next part -------------- An HTML attachment was scrubbed... URL: From wescpy at gmail.com Sat Feb 22 20:00:45 2014 From: wescpy at gmail.com (wesley chun) Date: Sat, 22 Feb 2014 11:00:45 -0800 Subject: [Python-authors] Python 101 - the book In-Reply-To: References: <9062A87B-8811-448F-9262-4A52A9DFB715@doughellmann.com> Message-ID: i did one years ago: - EuroPython 2011 talk description + video - OSCON 2009 slide deck cheers, and good luck! --wesley On Sat, Feb 22, 2014 at 9:10 AM, Mike Driscoll wrote: > Hi Doug, > > I'm not only going to blog about the progress, but also about the process > itself. There isn't enough information out there about how to write books > using Python tools. > > - Mike > > > On Sat, Feb 22, 2014 at 9:55 AM, Doug Hellmann wrote: > >> What a great idea! I hope you'll blog about your progress. >> >> Doug >> >> On Feb 19, 2014, at 10:56 AM, Mike Driscoll >> wrote: >> >> Hi, >> >> I've mentioned I'm working on a book on this list a few times. Well I've >> gotten over a dozen chapters written and I've started a Kickstarter for the >> project that I thought I'd share: >> >> http://kck.st/1kX98BB >> >> Authoring a book is a lot of fun and a lot of work. Thanks for all the >> help you all have given me! >> >> Mike >> >> P.S. I may ask more questions later! >> _______________________________________________ >> Python-authors mailing list >> Python-authors at python.org >> https://mail.python.org/mailman/listinfo/python-authors >> >> >> >> _______________________________________________ >> Python-authors mailing list >> Python-authors at python.org >> https://mail.python.org/mailman/listinfo/python-authors >> >> > > > -- > ----------------- > Mike Driscoll > > Blog: http://blog.pythonlibrary.org > > _______________________________________________ > Python-authors mailing list > Python-authors at python.org > https://mail.python.org/mailman/listinfo/python-authors > > -- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - "A computer never does what you want... only what you tell it." +wesley chun : wescpy at gmail : @wescpy Python training & consulting : http://CyberwebConsulting.com "Core Python" books : http://CorePython.com Python blog: http://wescpy.blogspot.com -------------- next part -------------- An HTML attachment was scrubbed... URL: From variedthoughts at gmail.com Mon Feb 24 02:09:31 2014 From: variedthoughts at gmail.com (Varied Thoughts) Date: Sun, 23 Feb 2014 17:09:31 -0800 Subject: [Python-authors] Python-authors Digest, Vol 26, Issue 2 In-Reply-To: References: Message-ID: <00D6BD59-D10C-4F6C-B361-B6CB80C12CB7@gmail.com> Hi all, I'm just about to put my first draft into some structure. It's in markdown-ish. I'd like to know more about the test scripts used. What are people using? Do you insert code an output into doc during make? Or extract code out of markdown somehow to run and test? Are you inserting the output into the doc? Or comparing the real output with the output listed in markdown doc? I know, ... So many questions. Regards, Brian Okken > On Feb 23, 2014, at 3:00 AM, python-authors-request at python.org wrote: > > Send Python-authors mailing list submissions to > python-authors at python.org > > To subscribe or unsubscribe via the World Wide Web, visit > https://mail.python.org/mailman/listinfo/python-authors > or, via email, send a message with subject or body 'help' to > python-authors-request at python.org > > You can reach the person managing the list at > python-authors-owner at python.org > > When replying, please edit your Subject line so it is more specific > than "Re: Contents of Python-authors digest..." > > > Today's Topics: > > 1. Re: Python 101 - the book (Doug Hellmann) > 2. Re: Python 101 - the book (Mike Driscoll) > 3. Re: Python 101 - the book (wesley chun) > > > ---------------------------------------------------------------------- > > Message: 1 > Date: Sat, 22 Feb 2014 10:55:23 -0500 > From: Doug Hellmann > To: Python Authors > Subject: Re: [Python-authors] Python 101 - the book > Message-ID: <9062A87B-8811-448F-9262-4A52A9DFB715 at doughellmann.com> > Content-Type: text/plain; charset="windows-1252" > > What a great idea! I hope you?ll blog about your progress. > > Doug > >> On Feb 19, 2014, at 10:56 AM, Mike Driscoll wrote: >> >> Hi, >> >> I've mentioned I'm working on a book on this list a few times. Well I've gotten over a dozen chapters written and I've started a Kickstarter for the project that I thought I'd share: >> >> http://kck.st/1kX98BB >> >> Authoring a book is a lot of fun and a lot of work. Thanks for all the help you all have given me! >> >> Mike >> >> P.S. I may ask more questions later! >> _______________________________________________ >> Python-authors mailing list >> Python-authors at python.org >> https://mail.python.org/mailman/listinfo/python-authors > > -------------- next part -------------- > An HTML attachment was scrubbed... > URL: > > ------------------------------ > > Message: 2 > Date: Sat, 22 Feb 2014 11:10:09 -0600 > From: Mike Driscoll > Cc: Python Authors > Subject: Re: [Python-authors] Python 101 - the book > Message-ID: > > Content-Type: text/plain; charset="iso-8859-1" > > Hi Doug, > > I'm not only going to blog about the progress, but also about the process > itself. There isn't enough information out there about how to write books > using Python tools. > > - Mike > > > On Sat, Feb 22, 2014 at 9:55 AM, Doug Hellmann wrote: > >> What a great idea! I hope you'll blog about your progress. >> >> Doug >> >> On Feb 19, 2014, at 10:56 AM, Mike Driscoll >> wrote: >> >> Hi, >> >> I've mentioned I'm working on a book on this list a few times. Well I've >> gotten over a dozen chapters written and I've started a Kickstarter for the >> project that I thought I'd share: >> >> http://kck.st/1kX98BB >> >> Authoring a book is a lot of fun and a lot of work. Thanks for all the >> help you all have given me! >> >> Mike >> >> P.S. I may ask more questions later! >> _______________________________________________ >> Python-authors mailing list >> Python-authors at python.org >> https://mail.python.org/mailman/listinfo/python-authors >> >> >> >> _______________________________________________ >> Python-authors mailing list >> Python-authors at python.org >> https://mail.python.org/mailman/listinfo/python-authors > > > -- > ----------------- > Mike Driscoll > > Blog: http://blog.pythonlibrary.org > -------------- next part -------------- > An HTML attachment was scrubbed... > URL: > > ------------------------------ > > Message: 3 > Date: Sat, 22 Feb 2014 11:00:45 -0800 > From: wesley chun > To: Mike Driscoll > Cc: Python Authors > Subject: Re: [Python-authors] Python 101 - the book > Message-ID: > > Content-Type: text/plain; charset="iso-8859-1" > > i did one years ago: > > - EuroPython 2011 talk description + > video > - OSCON 2009 slide > deck > > cheers, and good luck! > --wesley > > > On Sat, Feb 22, 2014 at 9:10 AM, Mike Driscoll wrote: > >> Hi Doug, >> >> I'm not only going to blog about the progress, but also about the process >> itself. There isn't enough information out there about how to write books >> using Python tools. >> >> - Mike >> >> >> On Sat, Feb 22, 2014 at 9:55 AM, Doug Hellmann wrote: >> >>> What a great idea! I hope you'll blog about your progress. >>> >>> Doug >>> >>> On Feb 19, 2014, at 10:56 AM, Mike Driscoll >>> wrote: >>> >>> Hi, >>> >>> I've mentioned I'm working on a book on this list a few times. Well I've >>> gotten over a dozen chapters written and I've started a Kickstarter for the >>> project that I thought I'd share: >>> >>> http://kck.st/1kX98BB >>> >>> Authoring a book is a lot of fun and a lot of work. Thanks for all the >>> help you all have given me! >>> >>> Mike >>> >>> P.S. I may ask more questions later! >>> _______________________________________________ >>> Python-authors mailing list >>> Python-authors at python.org >>> https://mail.python.org/mailman/listinfo/python-authors >>> >>> >>> >>> _______________________________________________ >>> Python-authors mailing list >>> Python-authors at python.org >>> https://mail.python.org/mailman/listinfo/python-authors >> >> >> -- >> ----------------- >> Mike Driscoll >> >> Blog: http://blog.pythonlibrary.org >> >> _______________________________________________ >> Python-authors mailing list >> Python-authors at python.org >> https://mail.python.org/mailman/listinfo/python-authors > > > -- > - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - > "A computer never does what you want... only what you tell it." > +wesley chun : wescpy at gmail : > @wescpy > Python training & consulting : http://CyberwebConsulting.com > "Core Python" books : http://CorePython.com > Python blog: http://wescpy.blogspot.com > -------------- next part -------------- > An HTML attachment was scrubbed... > URL: > > ------------------------------ > > Subject: Digest Footer > > _______________________________________________ > Python-authors mailing list > Python-authors at python.org > https://mail.python.org/mailman/listinfo/python-authors > > > ------------------------------ > > End of Python-authors Digest, Vol 26, Issue 2 > ********************************************* From aahz at pythoncraft.com Mon Feb 24 05:49:30 2014 From: aahz at pythoncraft.com (Aahz) Date: Sun, 23 Feb 2014 20:49:30 -0800 Subject: [Python-authors] Code in books In-Reply-To: <00D6BD59-D10C-4F6C-B361-B6CB80C12CB7@gmail.com> References: <00D6BD59-D10C-4F6C-B361-B6CB80C12CB7@gmail.com> Message-ID: <20140224044930.GA26019@panix.com> On Sun, Feb 23, 2014, Varied Thoughts wrote: > > I'm just about to put my first draft into some structure. > It's in markdown-ish. > I'd like to know more about the test scripts used. > > What are people using? My preference is to write in reST and use a custom directive that includes both text and output. -- Aahz (aahz at pythoncraft.com) <*> http://www.pythoncraft.com/ "usenet imitates usenet" --Darkhawk From harry.percival at gmail.com Mon Feb 24 09:37:24 2014 From: harry.percival at gmail.com (Harry Percival) Date: Mon, 24 Feb 2014 08:37:24 +0000 Subject: [Python-authors] Code in books In-Reply-To: <20140224044930.GA26019@panix.com> References: <00D6BD59-D10C-4F6C-B361-B6CB80C12CB7@gmail.com> <20140224044930.GA26019@panix.com> Message-ID: My book is structured like a tutorial, so each code example in the book builds on the last -- they don't stand alone. the book also contains lots of listings showing commands to run and expected output. So my test suite works by reading the book as HTML (I prefer that, helps catch any mistakes in my asciidoc syntax (ascidoc ~=rst)), parsing out all code examples and command-line listings, and then pretending to be the user, writing all the code examples to a folder in /tmp, and running all the commands, checking the outputs are actually as expected. it's quite challenging, especially as many of the code examples are partial extracts from a file -- "just change these three lines". that's easy for humans to figure out, harder for a computer test suite. In the end, I decided to have a parallel series of commits in the test repo for some of the book's more complicated code examples, one commit per code example in the book, and then the test script can just check that all the lines in the commit are in the book, and vice versa, and then use `patch` to apply it... It is quite possible that I'm over-egging the pudding. test suite is running at 6,000 lines of code currently. but, it's a book about testing, so it felt appropriate that it should have good tests. and, naturally, there are tests for the tests (for the tests in the book about testing). cheers! Harry http://www.obeythetestinggoat.com On 24 February 2014 04:49, Aahz wrote: > On Sun, Feb 23, 2014, Varied Thoughts wrote: > > > > I'm just about to put my first draft into some structure. > > It's in markdown-ish. > > I'd like to know more about the test scripts used. > > > > What are people using? > > My preference is to write in reST and use a custom directive that > includes both text and output. > -- > Aahz (aahz at pythoncraft.com) <*> > http://www.pythoncraft.com/ > > "usenet imitates usenet" --Darkhawk > _______________________________________________ > Python-authors mailing list > Python-authors at python.org > https://mail.python.org/mailman/listinfo/python-authors > -- ------------------------------ Harry J.W. Percival ------------------------------ Twitter: @hjwp Mobile: +44 (0) 78877 02511 Skype: harry.percival -------------- next part -------------- An HTML attachment was scrubbed... URL: From doug at doughellmann.com Mon Feb 24 17:09:51 2014 From: doug at doughellmann.com (Doug Hellmann) Date: Mon, 24 Feb 2014 11:09:51 -0500 Subject: [Python-authors] Python-authors Digest, Vol 26, Issue 2 In-Reply-To: <00D6BD59-D10C-4F6C-B361-B6CB80C12CB7@gmail.com> References: <00D6BD59-D10C-4F6C-B361-B6CB80C12CB7@gmail.com> Message-ID: <4851C9AE-999C-4604-9410-7BBDAF0770E4@doughellmann.com> I put the code in separate files from the reST and then use cog with sphinx to run the scripts and insert the output. That lets me commit the output to source control with the rest of the document, to catch changes between builds (I found a regression in a Python standard library module that way while working on PyMOTW). http://doughellmann.com/2009/02/02/writing-technical-documentation-with-sphinx-paver-and-cog.html https://bitbucket.org/dhellmann/sphinxcontrib-paverutils Doug On Feb 23, 2014, at 8:09 PM, Varied Thoughts wrote: > Hi all, > I'm just about to put my first draft into some structure. > It's in markdown-ish. > I'd like to know more about the test scripts used. > > What are people using? > > Do you insert code an output into doc during make? > Or extract code out of markdown somehow to run and test? > Are you inserting the output into the doc? > Or comparing the real output with the output listed in markdown doc? > > I know, ... So many questions. > > Regards, > Brian Okken > > >> On Feb 23, 2014, at 3:00 AM, python-authors-request at python.org wrote: >> >> Send Python-authors mailing list submissions to >> python-authors at python.org >> >> To subscribe or unsubscribe via the World Wide Web, visit >> https://mail.python.org/mailman/listinfo/python-authors >> or, via email, send a message with subject or body 'help' to >> python-authors-request at python.org >> >> You can reach the person managing the list at >> python-authors-owner at python.org >> >> When replying, please edit your Subject line so it is more specific >> than "Re: Contents of Python-authors digest..." >> >> >> Today's Topics: >> >> 1. Re: Python 101 - the book (Doug Hellmann) >> 2. Re: Python 101 - the book (Mike Driscoll) >> 3. Re: Python 101 - the book (wesley chun) >> >> >> ---------------------------------------------------------------------- >> >> Message: 1 >> Date: Sat, 22 Feb 2014 10:55:23 -0500 >> From: Doug Hellmann >> To: Python Authors >> Subject: Re: [Python-authors] Python 101 - the book >> Message-ID: <9062A87B-8811-448F-9262-4A52A9DFB715 at doughellmann.com> >> Content-Type: text/plain; charset="windows-1252" >> >> What a great idea! I hope you?ll blog about your progress. >> >> Doug >> >>> On Feb 19, 2014, at 10:56 AM, Mike Driscoll wrote: >>> >>> Hi, >>> >>> I've mentioned I'm working on a book on this list a few times. Well I've gotten over a dozen chapters written and I've started a Kickstarter for the project that I thought I'd share: >>> >>> http://kck.st/1kX98BB >>> >>> Authoring a book is a lot of fun and a lot of work. Thanks for all the help you all have given me! >>> >>> Mike >>> >>> P.S. I may ask more questions later! >>> _______________________________________________ >>> Python-authors mailing list >>> Python-authors at python.org >>> https://mail.python.org/mailman/listinfo/python-authors >> >> -------------- next part -------------- >> An HTML attachment was scrubbed... >> URL: >> >> ------------------------------ >> >> Message: 2 >> Date: Sat, 22 Feb 2014 11:10:09 -0600 >> From: Mike Driscoll >> Cc: Python Authors >> Subject: Re: [Python-authors] Python 101 - the book >> Message-ID: >> >> Content-Type: text/plain; charset="iso-8859-1" >> >> Hi Doug, >> >> I'm not only going to blog about the progress, but also about the process >> itself. There isn't enough information out there about how to write books >> using Python tools. >> >> - Mike >> >> >> On Sat, Feb 22, 2014 at 9:55 AM, Doug Hellmann wrote: >> >>> What a great idea! I hope you'll blog about your progress. >>> >>> Doug >>> >>> On Feb 19, 2014, at 10:56 AM, Mike Driscoll >>> wrote: >>> >>> Hi, >>> >>> I've mentioned I'm working on a book on this list a few times. Well I've >>> gotten over a dozen chapters written and I've started a Kickstarter for the >>> project that I thought I'd share: >>> >>> http://kck.st/1kX98BB >>> >>> Authoring a book is a lot of fun and a lot of work. Thanks for all the >>> help you all have given me! >>> >>> Mike >>> >>> P.S. I may ask more questions later! >>> _______________________________________________ >>> Python-authors mailing list >>> Python-authors at python.org >>> https://mail.python.org/mailman/listinfo/python-authors >>> >>> >>> >>> _______________________________________________ >>> Python-authors mailing list >>> Python-authors at python.org >>> https://mail.python.org/mailman/listinfo/python-authors >> >> >> -- >> ----------------- >> Mike Driscoll >> >> Blog: http://blog.pythonlibrary.org >> -------------- next part -------------- >> An HTML attachment was scrubbed... >> URL: >> >> ------------------------------ >> >> Message: 3 >> Date: Sat, 22 Feb 2014 11:00:45 -0800 >> From: wesley chun >> To: Mike Driscoll >> Cc: Python Authors >> Subject: Re: [Python-authors] Python 101 - the book >> Message-ID: >> >> Content-Type: text/plain; charset="iso-8859-1" >> >> i did one years ago: >> >> - EuroPython 2011 talk description + >> video >> - OSCON 2009 slide >> deck >> >> cheers, and good luck! >> --wesley >> >> >> On Sat, Feb 22, 2014 at 9:10 AM, Mike Driscoll wrote: >> >>> Hi Doug, >>> >>> I'm not only going to blog about the progress, but also about the process >>> itself. There isn't enough information out there about how to write books >>> using Python tools. >>> >>> - Mike >>> >>> >>> On Sat, Feb 22, 2014 at 9:55 AM, Doug Hellmann wrote: >>> >>>> What a great idea! I hope you'll blog about your progress. >>>> >>>> Doug >>>> >>>> On Feb 19, 2014, at 10:56 AM, Mike Driscoll >>>> wrote: >>>> >>>> Hi, >>>> >>>> I've mentioned I'm working on a book on this list a few times. Well I've >>>> gotten over a dozen chapters written and I've started a Kickstarter for the >>>> project that I thought I'd share: >>>> >>>> http://kck.st/1kX98BB >>>> >>>> Authoring a book is a lot of fun and a lot of work. Thanks for all the >>>> help you all have given me! >>>> >>>> Mike >>>> >>>> P.S. I may ask more questions later! >>>> _______________________________________________ >>>> Python-authors mailing list >>>> Python-authors at python.org >>>> https://mail.python.org/mailman/listinfo/python-authors >>>> >>>> >>>> >>>> _______________________________________________ >>>> Python-authors mailing list >>>> Python-authors at python.org >>>> https://mail.python.org/mailman/listinfo/python-authors >>> >>> >>> -- >>> ----------------- >>> Mike Driscoll >>> >>> Blog: http://blog.pythonlibrary.org >>> >>> _______________________________________________ >>> Python-authors mailing list >>> Python-authors at python.org >>> https://mail.python.org/mailman/listinfo/python-authors >> >> >> -- >> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - >> "A computer never does what you want... only what you tell it." >> +wesley chun : wescpy at gmail : >> @wescpy >> Python training & consulting : http://CyberwebConsulting.com >> "Core Python" books : http://CorePython.com >> Python blog: http://wescpy.blogspot.com >> -------------- next part -------------- >> An HTML attachment was scrubbed... >> URL: >> >> ------------------------------ >> >> Subject: Digest Footer >> >> _______________________________________________ >> Python-authors mailing list >> Python-authors at python.org >> https://mail.python.org/mailman/listinfo/python-authors >> >> >> ------------------------------ >> >> End of Python-authors Digest, Vol 26, Issue 2 >> ********************************************* > _______________________________________________ > Python-authors mailing list > Python-authors at python.org > https://mail.python.org/mailman/listinfo/python-authors