aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/tools/cython/README.rst
diff options
context:
space:
mode:
authoralexv-smirnov <alex@ydb.tech>2023-03-15 19:59:12 +0300
committeralexv-smirnov <alex@ydb.tech>2023-03-15 19:59:12 +0300
commit056bb284ccf8dd6793ec3a54ffa36c4fb2b9ad11 (patch)
tree4740980126f32e3af7937ba0ca5f83e59baa4ab0 /contrib/tools/cython/README.rst
parent269126dcced1cc8b53eb4398b4a33e5142f10290 (diff)
downloadydb-056bb284ccf8dd6793ec3a54ffa36c4fb2b9ad11.tar.gz
add library/cpp/actors, ymake build to ydb oss export
Diffstat (limited to 'contrib/tools/cython/README.rst')
-rw-r--r--contrib/tools/cython/README.rst86
1 files changed, 86 insertions, 0 deletions
diff --git a/contrib/tools/cython/README.rst b/contrib/tools/cython/README.rst
new file mode 100644
index 0000000000..fe4b5958a1
--- /dev/null
+++ b/contrib/tools/cython/README.rst
@@ -0,0 +1,86 @@
+Welcome to Cython!
+==================
+
+Cython is a language that makes writing C extensions for
+Python as easy as Python itself. Cython is based on
+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.
+
+* Official website: http://cython.org/
+* Documentation: http://docs.cython.org/en/latest/
+* Github repository: https://github.com/cython/cython
+* Wiki: https://github.com/cython/cython/wiki
+
+
+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>`_.
+
+
+License:
+--------
+
+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>`_.
+
+
+Contributing:
+-------------
+
+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>`_.
+
+
+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
+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::
+
+ 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.