README.txt 2.12 KB
Newer Older
William Stein's avatar
William Stein committed
1 2 3
Welcome to Cython!
=================

Stefan Behnel's avatar
Stefan Behnel committed
4 5 6 7 8 9 10 11 12 13 14 15
Cython (http://cython.org) is a language that makes writing C extensions for
the Python language as easy as Python itself.  Cython is based on the
well-known Pyrex, but supports more cutting edge functionality and
optimizations.

The Cython language is very close to the Python language, but Cython
additionally supports calling C functions and declaring C types on variables
and class attributes.  This allows the compiler to generate very efficient C
code from Cython code.

This makes Cython the ideal language for wrapping external C libraries, and
for fast C modules that speed up the execution of Python code.
William Stein's avatar
William Stein committed
16 17 18 19

LICENSE:

The original Pyrex program was licensed "free of restrictions" (see
Stefan Behnel's avatar
Stefan Behnel committed
20
below).  Cython itself is licensed under the permissive
William Stein's avatar
William Stein committed
21

Stefan Behnel's avatar
Stefan Behnel committed
22
   Apache License
William Stein's avatar
William Stein committed
23

Stefan Behnel's avatar
Stefan Behnel committed
24
See LICENSE.txt.
William Stein's avatar
William Stein committed
25 26


27
--------------------------
William Stein's avatar
William Stein committed
28

Stefan Behnel's avatar
Stefan Behnel committed
29 30 31 32
Note that Cython no longer ships the Mercurial (hg) repository in its
source distribution.  To get the full source history, make sure you
have hg installed, then step into the base directory of the Cython
source distribution and type
William Stein's avatar
William Stein committed
33

Stefan Behnel's avatar
Stefan Behnel committed
34
    make repo
William Stein's avatar
William Stein committed
35

Stefan Behnel's avatar
Stefan Behnel committed
36
Alternatively, check out the latest developer repository from
William Stein's avatar
William Stein committed
37

Stefan Behnel's avatar
Stefan Behnel committed
38
    http://hg.cython.org/cython-devel
William Stein's avatar
William Stein committed
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68



The following is from Pyrex:
------------------------------------------------------
This is a development version of Pyrex, a language
for writing Python extension modules.

For more info, see:

    Doc/About.html for a description of the language
    INSTALL.txt    for installation instructions
    USAGE.txt      for usage instructions
    Demos          for usage examples

Comments, suggestions, bug reports, etc. are
welcome!

Copyright stuff: Pyrex is free of restrictions. You
may use, redistribute, modify and distribute modified
versions.

The latest version of Pyrex can be found here:

http://www.cosc.canterbury.ac.nz/~greg/python/Pyrex/

Greg Ewing, Computer Science Dept, +--------------------------------------+
University of Canterbury,          | A citizen of NewZealandCorp, a       |
Christchurch, New Zealand          | wholly-owned subsidiary of USA Inc.  |
greg@cosc.canterbury.ac.nz         +--------------------------------------+