Differences between revisions 1 and 16 (spanning 15 versions)
Revision 1 as of 2006-03-08 19:23:06
Size: 205
Editor: CameronLaird
Comment:
Revision 16 as of 2006-08-18 15:28:02
Size: 9336
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
On the suggestion of JeffRush, I created this page. Existing material appears (also) at EvangelismSupportMaterials and PromotingPythonBof. Existing material appears (also) at ["evangelism_support_materials"] and PromotingPythonBof.
Line 3: Line 3:

== General Notes ==

Advocacy is the process of letting people know what Python is
good at, and drawing them into using the language. The most effective
forms of advocacy lure users to the language by impressing them
with results, rather than brow beating or lecturing them on language design.

Published articles that answer the question "how do I solve X with Python?" are a good way to get people interested.

One goal for writing articles might be to develop a library of
HOW-TOs for Python. Much information exists, but it has not been
collected for convenient access from python.org, and there are
certainly gaps in covering key strengths of Python.

A collection of [http://python.org/about/success Python Success Stories] already exists. These are also useful, usually by helping engineers convince their bosses that Python is worthy of attention. But success stories tend to be lean on "how-to" style information, so they do not offer a convenient path to get new users working with Python.

== Print Magazines that Accept Technical Articles ==

We would like to focus on those magazines outside the Python community, in order to reach those who don't know about us. Also there are many magazines that accept press releases that do not accept articles. We need those that welcome articles.

 * [http://linuxjournal.com Linux Journal] [http://www.linuxjournal.com/xstatic/author/index Author Guidelines]
 * [http://www.ddj.com Dr. Dobbs Journal] [http://www.ddj.com/authors.htm Author Guidelines]
 * [http://byte.com Byte Magazine] (no guidelines found; may not accept non-staff material)
 * [http://www.mactech.com MacTech Magazine] [http://www.mactech.com/editorial/writersguide.html Author Guidelines]

== Electronic Magazines that Accept Technical Articles ==

 * [http://arstechnica.com Ars Technica] [http://arstechnica.com/site/styleguide.ars Author Guidelines]

== Magazine Articles About Python I Would Like to See ==
 * Python and Relational Databases

   Talk about the DB-API that Python has standardized on, and how easy it is to write conventional SQL. Then move into one of the ORMs for Python, perhaps SQLObject or SQLAlchemy. Discuss how data types are automatically converted, and how cross-platform the solution is. Highlight the different database engines supported, both open source and commercial.

 * Python and Object Databases

   Talk about how dynamic languages make a good match for object databases, with seamless serialization. Provide an overview of how an object database works, but focus on the end-developer and not the underlying mechanisms. Cover how the databases retain transaction support, and to what degree they provide support for the principles of ACID. Discuss the popular ZODB, Durus and APE frameworks, their tradeoffs (e.g. read-mostly usage, transaction rates) and the fact that they can be used standalone without the baggage of Zope or Quixote. Cover their lack of granular security and user identities at the database API level.

 * Handling Email with Python

   Perhaps as a two part article, cover the essentials of first parsing an incoming email and then generating an outgoing. Demonstrate how the email module makes it easy to handle multi-part email bodies and convert various character sets into unicode, which Python supports natively. Also cover how the email module supports the use of international message headers and handles their conversion between the 7-bit ASCII used on the wire. Show how the email module addresses the issue of date and addressee parsing. End with how the support of iterators makes it easy to walk over complex emails and touch upon the support added in Python 2.5 for writing email archives.

 * Image Processing, Array Numerics and Python

   Combine the use of the Python Imaging Library (PIL) module and one of the numeric modules and demonstrate how to effectively process large arrays of data, using images as something non-scientists can follow. Cover the array module, its strengths and weaknesses and then move on to the numpy/numeric/scipy framework.

   Note that this article could also be written using the processing of audio data instead.

 * Functional Programming in Python

   Provide an overview with examples of the functional programming features of Python. Cover the lambda, map and reduce functions but move on to the new all(), any() and generator/coroutine support in Python 2.5. Discuss the broad support Python iterators and the functionality in the itertools and functools (new in Python 2.5) modules.

 * Mixing Network Protocols in Python

   Gradually assemble an example using the Twisted framework of how a single Python program can serve web pages as well as handle the telnet or imap/pop protocols.

   One idea is to create a telnet-based chat room, with the web page displaying a list of attendees and any icon/slogan they may have set on their avatar via the telnet interface.

   The Twisted framework is complex and powerful so the article needs to keep things simple in this introductory article.

 * Interacting with Python at the Prompt

   Introduce the read to the interactive nature of Python, not just the entering of expressions but use of the inspect module, how tracebacks are a programmer's friend and using the pprint module to display complex data structures.

 * Packaging your Python Application for Distribution

   Provide an introduction to the various packaging options for Python. Start with simple package imports and use of the zipimport module, work up to the distutils module and provide a light introduction to eggs. Wrap up with mention of the cheeseshop, what it is for and how to use easy_install to cryptographically sign and upload your work. Discuss briefly dependency resolution and perhaps compare it all to the CPAN network.

   Focus on what is needed to package an application and not on the underlying egg magic. Act like the reader is someone new to Python who has been given the task of packaging an existing application he didn't write.

 * Testing Your Python Program

   Introduce the reader to the test frameworks of Python. Cover the test and unittest modules, to show the conventional ways of building tests. Then progress to the doctest module, a more Pythonic approach, including both tests in the doc strings as well as those in standalone text files. For ideas/examples, look at how Zope3 has used text tutorial documents with embedded doctest expressions to combine teaching and testing. Consult the handouts from the Agile Testing tutorial at PyCon 2006 for other ideas of what to cover.

 * Going International with Python

   Introduce the reader to the comprehensive support Python has for unicode. Cover the various codecs and the unicodedata and stringprep modules. Demonstrate use of the locale and gettest modules.

   Do something with the unicode, not just discuss it in an abstract manner. Perhaps show off a simple web server delivering unicode or an email generator.

 * Working at the Prompt - Shell Utilities in Python

   Reach out to the bash/awk/sed scripter. Start with the flexible parsing of command-line arguments we have in the getopt/optparse modules. Demonstrate line-by-line file processing, and cover the shutil and commands modules. For an advanced wrapup touch upon the curses module and how non-graphic apps can be quickly written in Python.

 * Processing Compressed Archives with Python

   Python has rich support for handling compressed files and archives. Demonstrate the gzip, zlib, bz2 modules for compressing single files and then advance to full archives, using the zipfile and tarfile. Wrap up with a demonstration of use, showing off the zipimport module.

 * Debugging and Profiling Your Python Code

   Talk about the power of the Python debugger, along with the profiler module and the (new for Python 2.5) cProfiler module. Contrast both the short-term ability to break on flexible conditions with the ability to profile code over the long-term. Discuss code coverage functionality and end with mentions of some of the IDE environments for Python that make some of this even easier.

 * Writing a Web Client with Python

   Walk the reader thru the creation of a program to fetch content from a website, starting with simple HTML text, adding basic/digest authentication, cookie support and SSL certificate checking. Also discuss having this program talk thru a web proxy ala SOCKS and briefly cover parsing the retrieved page using one of the DOM modules. This article would cover a lot of the API in the urllib2 module. Also show use of the robotparser module so that the client doesn't walk sites it should not.

 * System Administration with Python

   Highlight the useful Windows system administration tasks that can be achieved through Python - registry editing etc.

For active discussion on advocating for Python, please join the mailing list at [http://wingware.com/mailman/listinfo/marketing-python]

WellKnownPythonPrograms - you may already be using Python!
----
CategoryAdvocacy

Existing material appears (also) at ["evangelism_support_materials"] and PromotingPythonBof. Note [http://psf.pollenation.net/cgi-bin/trac.cgi/ticket/160].

General Notes

Advocacy is the process of letting people know what Python is good at, and drawing them into using the language. The most effective forms of advocacy lure users to the language by impressing them with results, rather than brow beating or lecturing them on language design.

Published articles that answer the question "how do I solve X with Python?" are a good way to get people interested.

One goal for writing articles might be to develop a library of HOW-TOs for Python. Much information exists, but it has not been collected for convenient access from python.org, and there are certainly gaps in covering key strengths of Python.

A collection of [http://python.org/about/success Python Success Stories] already exists. These are also useful, usually by helping engineers convince their bosses that Python is worthy of attention. But success stories tend to be lean on "how-to" style information, so they do not offer a convenient path to get new users working with Python.

We would like to focus on those magazines outside the Python community, in order to reach those who don't know about us. Also there are many magazines that accept press releases that do not accept articles. We need those that welcome articles.

Electronic Magazines that Accept Technical Articles

Magazine Articles About Python I Would Like to See

  • Python and Relational Databases
    • Talk about the DB-API that Python has standardized on, and how easy it is to write conventional SQL. Then move into one of the ORMs for Python, perhaps SQLObject or SQLAlchemy. Discuss how data types are automatically converted, and how cross-platform the solution is. Highlight the different database engines supported, both open source and commercial.
  • Python and Object Databases
    • Talk about how dynamic languages make a good match for object databases, with seamless serialization. Provide an overview of how an object database works, but focus on the end-developer and not the underlying mechanisms. Cover how the databases retain transaction support, and to what degree they provide support for the principles of ACID. Discuss the popular ZODB, Durus and APE frameworks, their tradeoffs (e.g. read-mostly usage, transaction rates) and the fact that they can be used standalone without the baggage of Zope or Quixote. Cover their lack of granular security and user identities at the database API level.
  • Handling Email with Python
    • Perhaps as a two part article, cover the essentials of first parsing an incoming email and then generating an outgoing. Demonstrate how the email module makes it easy to handle multi-part email bodies and convert various character sets into unicode, which Python supports natively. Also cover how the email module supports the use of international message headers and handles their conversion between the 7-bit ASCII used on the wire. Show how the email module addresses the issue of date and addressee parsing. End with how the support of iterators makes it easy to walk over complex emails and touch upon the support added in Python 2.5 for writing email archives.
  • Image Processing, Array Numerics and Python
    • Combine the use of the Python Imaging Library (PIL) module and one of the numeric modules and demonstrate how to effectively process large arrays of data, using images as something non-scientists can follow. Cover the array module, its strengths and weaknesses and then move on to the numpy/numeric/scipy framework. Note that this article could also be written using the processing of audio data instead.
  • Functional Programming in Python
    • Provide an overview with examples of the functional programming features of Python. Cover the lambda, map and reduce functions but move on to the new all(), any() and generator/coroutine support in Python 2.5. Discuss the broad support Python iterators and the functionality in the itertools and functools (new in Python 2.5) modules.
  • Mixing Network Protocols in Python
    • Gradually assemble an example using the Twisted framework of how a single Python program can serve web pages as well as handle the telnet or imap/pop protocols. One idea is to create a telnet-based chat room, with the web page displaying a list of attendees and any icon/slogan they may have set on their avatar via the telnet interface. The Twisted framework is complex and powerful so the article needs to keep things simple in this introductory article.
  • Interacting with Python at the Prompt
    • Introduce the read to the interactive nature of Python, not just the entering of expressions but use of the inspect module, how tracebacks are a programmer's friend and using the pprint module to display complex data structures.
  • Packaging your Python Application for Distribution
    • Provide an introduction to the various packaging options for Python. Start with simple package imports and use of the zipimport module, work up to the distutils module and provide a light introduction to eggs. Wrap up with mention of the cheeseshop, what it is for and how to use easy_install to cryptographically sign and upload your work. Discuss briefly dependency resolution and perhaps compare it all to the CPAN network. Focus on what is needed to package an application and not on the underlying egg magic. Act like the reader is someone new to Python who has been given the task of packaging an existing application he didn't write.
  • Testing Your Python Program
    • Introduce the reader to the test frameworks of Python. Cover the test and unittest modules, to show the conventional ways of building tests. Then progress to the doctest module, a more Pythonic approach, including both tests in the doc strings as well as those in standalone text files. For ideas/examples, look at how Zope3 has used text tutorial documents with embedded doctest expressions to combine teaching and testing. Consult the handouts from the Agile Testing tutorial at PyCon 2006 for other ideas of what to cover.

  • Going International with Python
    • Introduce the reader to the comprehensive support Python has for unicode. Cover the various codecs and the unicodedata and stringprep modules. Demonstrate use of the locale and gettest modules. Do something with the unicode, not just discuss it in an abstract manner. Perhaps show off a simple web server delivering unicode or an email generator.
  • Working at the Prompt - Shell Utilities in Python
    • Reach out to the bash/awk/sed scripter. Start with the flexible parsing of command-line arguments we have in the getopt/optparse modules. Demonstrate line-by-line file processing, and cover the shutil and commands modules. For an advanced wrapup touch upon the curses module and how non-graphic apps can be quickly written in Python.
  • Processing Compressed Archives with Python
    • Python has rich support for handling compressed files and archives. Demonstrate the gzip, zlib, bz2 modules for compressing single files and then advance to full archives, using the zipfile and tarfile. Wrap up with a demonstration of use, showing off the zipimport module.
  • Debugging and Profiling Your Python Code
    • Talk about the power of the Python debugger, along with the profiler module and the (new for Python 2.5) cProfiler module. Contrast both the short-term ability to break on flexible conditions with the ability to profile code over the long-term. Discuss code coverage functionality and end with mentions of some of the IDE environments for Python that make some of this even easier.
  • Writing a Web Client with Python
    • Walk the reader thru the creation of a program to fetch content from a website, starting with simple HTML text, adding basic/digest authentication, cookie support and SSL certificate checking. Also discuss having this program talk thru a web proxy ala SOCKS and briefly cover parsing the retrieved page using one of the DOM modules. This article would cover a lot of the API in the urllib2 module. Also show use of the robotparser module so that the client doesn't walk sites it should not.
  • System Administration with Python
    • Highlight the useful Windows system administration tasks that can be achieved through Python - registry editing etc.

For active discussion on advocating for Python, please join the mailing list at [http://wingware.com/mailman/listinfo/marketing-python]

WellKnownPythonPrograms - you may already be using Python!


CategoryAdvocacy

Advocacy (last edited 2009-10-30 02:22:47 by panix3)

Unable to edit the page? See the FrontPage for instructions.