docs/overview.rst

   1 .. highlight:: cython
   2
   3 .. _overview:
   4
   5 ********
   6 Overview
   7 ********
   8
   9 About Cython
  10 ==============
  11
  12 Cython is a language that makes writing C extensions for the Python language
  13 as easy as Python itself. Cython is based on the well-known `Pyrex
  14 <http://www.cosc.canterbury.ac.nz/greg.ewing/python/Pyrex/>`_ language by Greg Ewing,
  15 but supports more cutting edge functionality and optimizations [#]_.
  16 The Cython language is very close to the Python language, but Cython
  17 additionally supports calling C functions and declaring C types on variables
  18 and class attributes. This allows the compiler to generate very efficient C
  19 code from Cython code.
  20
  21 This makes Cython the ideal language for wrapping external C libraries,
  22 and for fast C modules that speed up the execution of Python code.
  23
  24 Future Plans
  25 ============
  26 Cython is not finished. Substantial tasks remaining. See
  27 :ref:`cython-limitations` for a current list.
  28
  29 .. rubric:: Footnotes
  30
  31 .. [#] For differences with Pyrex see :ref:`pyrex-differences`.
  32