Metadata-Version: 2.1
Name: cython-package-example
Version: 0.1.6
Summary: Example of a package with Cython extensions
Home-page: https://github.com/FedericoStra/cython-package-example
Author: Federico Stra
Author-email: stra.federico@gmail.com
License: MIT
Project-URL: Documentation, https://github.com/FedericoStra/cython-package-example
Project-URL: Code, https://github.com/FedericoStra/cython-package-example
Project-URL: Issue tracker, https://github.com/FedericoStra/cython-package-example/issues
Platform: UNKNOWN
Classifier: Development Status :: 1 - Planning
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: C
Classifier: Programming Language :: Cython
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: Implementation :: CPython
Requires-Python: >=3.4
Description-Content-Type: text/markdown
Provides-Extra: dev
Provides-Extra: docs
License-File: LICENSE.txt

Cython package example
======================

Purpose
-------

The purpose of this package is to demonstrate how to organize a project developed using Cython.
It shows a suitable folder structure according to the best practices, how to create extension modules with Cython, how to implement functions in C and make them available to Cython, how to include package data, how to write a `setup.py` script that allows users without Cython to install the package nonetheless.

Installation
------------

### From a repository checkout

```bash
make install
```
or
```bash
CYTHONIZE=1 pip install --user .
```

### From PyPi

```bash
pip install --user cython-package-example
```


