README.rst 2.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586
  1. Welcome to Cython!
  2. ==================
  3. Cython is a language that makes writing C extensions for
  4. Python as easy as Python itself. Cython is based on
  5. Pyrex, but supports more cutting edge functionality and
  6. optimizations.
  7. The Cython language is very close to the Python language, but Cython
  8. additionally supports calling C functions and declaring C types on variables
  9. and class attributes. This allows the compiler to generate very efficient C
  10. code from Cython code.
  11. This makes Cython the ideal language for wrapping external C libraries, and
  12. for fast C modules that speed up the execution of Python code.
  13. * Official website: http://cython.org/
  14. * Documentation: http://docs.cython.org/en/latest/
  15. * Github repository: https://github.com/cython/cython
  16. * Wiki: https://github.com/cython/cython/wiki
  17. Installation:
  18. -------------
  19. If you already have a C compiler, just do::
  20. pip install Cython
  21. otherwise, see `the installation page <http://docs.cython.org/en/latest/src/quickstart/install.html>`_.
  22. License:
  23. --------
  24. The original Pyrex program was licensed "free of restrictions" (see below).
  25. Cython itself is licensed under the permissive **Apache License**.
  26. See `LICENSE.txt <https://github.com/cython/cython/blob/master/LICENSE.txt>`_.
  27. Contributing:
  28. -------------
  29. Want to contribute to the Cython project?
  30. Here is some `help to get you started <https://github.com/cython/cython/blob/master/docs/CONTRIBUTING.rst>`_.
  31. Get the full source history:
  32. ----------------------------
  33. Note that Cython used to ship the full version control repository in its source
  34. distribution, but no longer does so due to space constraints. To get the
  35. full source history from a downloaded source archive, make sure you have git
  36. installed, then step into the base directory of the Cython source distribution
  37. and type::
  38. make repo
  39. The following is from Pyrex:
  40. ------------------------------------------------------
  41. This is a development version of Pyrex, a language
  42. for writing Python extension modules.
  43. For more info, see:
  44. * Doc/About.html for a description of the language
  45. * INSTALL.txt for installation instructions
  46. * USAGE.txt for usage instructions
  47. * Demos for usage examples
  48. Comments, suggestions, bug reports, etc. are
  49. welcome!
  50. Copyright stuff: Pyrex is free of restrictions. You
  51. may use, redistribute, modify and distribute modified
  52. versions.
  53. The latest version of Pyrex can be found `here <http://www.cosc.canterbury.ac.nz/~greg/python/Pyrex/>`_.
  54. | Greg Ewing, Computer Science Dept
  55. | University of Canterbury
  56. | Christchurch, New Zealand
  57. A citizen of NewZealandCorp, a wholly-owned subsidiary of USA Inc.