README.rst 2.91 KB
Newer Older
1
Welcome to Cython!
gabrieldemarmiesse's avatar
gabrieldemarmiesse committed
2 3 4
==================

Cython is a language that makes writing C extensions for
Stefan Behnel's avatar
Stefan Behnel committed
5 6
Python as easy as Python itself.  Cython is based on
Pyrex, but supports more cutting edge functionality and
gabrieldemarmiesse's avatar
gabrieldemarmiesse committed
7 8 9 10 11 12 13 14 15 16
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.

17 18
* Official website: https://cython.org/
* Documentation: http://docs.cython.org/
gabrieldemarmiesse's avatar
gabrieldemarmiesse committed
19 20 21
* Github repository: https://github.com/cython/cython
* Wiki: https://github.com/cython/cython/wiki

22 23 24 25
You can **support the Cython project** via
`Github Sponsors <https://github.com/users/scoder/sponsorship>`_ or
`Tidelift <https://tidelift.com/subscription/pkg/pypi-cython>`_.

gabrieldemarmiesse's avatar
gabrieldemarmiesse committed
26 27 28 29 30 31 32 33 34 35 36

Installation:
-------------

If you already have a C compiler, just do::

   pip install Cython

otherwise, see `the installation page <http://docs.cython.org/en/latest/src/quickstart/install.html>`_.


37
License:
gabrieldemarmiesse's avatar
gabrieldemarmiesse committed
38 39 40 41 42 43 44 45
--------

The original Pyrex program was licensed "free of restrictions" (see below).
Cython itself is licensed under the permissive **Apache License**.

See `LICENSE.txt <https://github.com/cython/cython/blob/master/LICENSE.txt>`_.


46 47 48
Contributing:
-------------

49 50
Want to contribute to the Cython project?
Here is some `help to get you started <https://github.com/cython/cython/blob/master/docs/CONTRIBUTING.rst>`_.
51

52 53 54 55
We are currently building the next great Cython edition:
`Cython 3.0 <https://github.com/cython/cython/milestone/58>`_.
You can help us make the life of Python 3.x users easier.

56

gabrieldemarmiesse's avatar
gabrieldemarmiesse committed
57 58 59 60 61
Get the full source history:
----------------------------

Note that Cython used to ship the full version control repository in its source
distribution, but no longer does so due to space constraints.  To get the
62 63 64
full source history from a downloaded source archive, make sure you have git
installed, then step into the base directory of the Cython source distribution
and type::
gabrieldemarmiesse's avatar
gabrieldemarmiesse committed
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94

    make repo


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
| Christchurch, New Zealand

 A citizen of NewZealandCorp, a wholly-owned subsidiary of USA Inc.