Merge pull request #4 from jakirkham/use_cython_tmplt

Update project to use Cython

.appveyor_support/environments/dpl.yml

@@ -4,8 +4,9 @@ channels:
   - conda-forge
 
 dependencies:
-  - python==3.6
+  - python=3.6.*
   - pip==18.0
   - wheel==0.31.1
+  - cython==0.28.5
   - coverage==4.5.1
   - coveralls==1.3.0

.appveyor_support/environments/tst_py27.yml

@@ -1,9 +1,11 @@
-name: pysharedmem_env
+name: pysharedmem_py27_env
 
 channels:
   - conda-forge
 
 dependencies:
+  - python=2.7.*
   - pip==18.0
   - wheel==0.31.1
+  - cython==0.28.5
   - coverage==4.5.1

.appveyor_support/environments/tst_py35.yml

@@ -1,9 +1,11 @@
-name: pysharedmem_env
+name: pysharedmem_py35_env
 
 channels:
   - conda-forge
 
 dependencies:
+  - python=3.5.*
   - pip==18.0
   - wheel==0.31.1
+  - cython==0.28.5
   - coverage==4.5.1

.appveyor_support/environments/tst_py36.yml

@@ -1,9 +1,11 @@
-name: pysharedmem_env
+name: pysharedmem_py36_env
 
 channels:
   - conda-forge
 
 dependencies:
+  - python=3.6.*
   - pip==18.0
   - wheel==0.31.1
+  - cython==0.28.5
   - coverage==4.5.1

.circleci/environments/dpl.yml

@@ -4,8 +4,9 @@ channels:
   - conda-forge
 
 dependencies:
-  - python==3.6
+  - python=3.6.*
   - pip==18.0
   - wheel==0.31.1
+  - cython==0.28.5
   - coverage==4.5.1
   - coveralls==1.3.0

.circleci/environments/tst_py27.yml

@@ -1,9 +1,11 @@
-name: pysharedmem_env
+name: pysharedmem_py27_env
 
 channels:
   - conda-forge
 
 dependencies:
+  - python=2.7.*
   - pip==18.0
   - wheel==0.31.1
+  - cython==0.28.5
   - coverage==4.5.1

.circleci/environments/tst_py35.yml

@@ -1,9 +1,11 @@
-name: pysharedmem_env
+name: pysharedmem_py35_env
 
 channels:
   - conda-forge
 
 dependencies:
+  - python=3.5.*
   - pip==18.0
   - wheel==0.31.1
+  - cython==0.28.5
   - coverage==4.5.1

.circleci/environments/tst_py36.yml

@@ -1,9 +1,11 @@
-name: pysharedmem_env
+name: pysharedmem_py36_env
 
 channels:
   - conda-forge
 
 dependencies:
+  - python=3.6.*
   - pip==18.0
   - wheel==0.31.1
+  - cython==0.28.5
   - coverage==4.5.1

.coveragerc

@@ -1,8 +1,14 @@
 [run]
 branch = True
 source = pysharedmem
+plugins = Cython.Coverage
 [report]
 exclude_lines =
+    # Include the no cover pragma as it needs to be listed explicitly when
+    # using exclude_lines.
+    # ( http://coverage.readthedocs.io/en/coverage-4.1/excluding.html#advanced-exclusion )
+    pragma: no cover
+
     # Ignore coverage of code that requires the module to be executed.
     if __name__ == .__main__.:
 

.gitattributes

@@ -1,4 +1,4 @@
-pysharedmem/_version.py export-subst
+_version.py export-subst
 
 *.bat text eol=crlf
 *.sh text eol=lf

.gitignore

@@ -5,6 +5,8 @@ __pycache__/
 
 # C extensions
 *.so
+src/pysharedmem.c
+src/version.pxi
 
 # Distribution / packaging
 .Python

.travis_support/environments/dpl.yml

@@ -4,8 +4,9 @@ channels:
   - conda-forge
 
 dependencies:
-  - python==3.6
+  - python=3.6.*
   - pip==18.0
   - wheel==0.31.1
+  - cython==0.28.5
   - coverage==4.5.1
   - coveralls==1.3.0

.travis_support/environments/tst_py27.yml

@@ -1,9 +1,11 @@
-name: pysharedmem_env
+name: pysharedmem_py27_env
 
 channels:
   - conda-forge
 
 dependencies:
+  - python=2.7.*
   - pip==18.0
   - wheel==0.31.1
+  - cython==0.28.5
   - coverage==4.5.1

.travis_support/environments/tst_py35.yml

@@ -1,9 +1,11 @@
-name: pysharedmem_env
+name: pysharedmem_py35_env
 
 channels:
   - conda-forge
 
 dependencies:
+  - python=3.5.*
   - pip==18.0
   - wheel==0.31.1
+  - cython==0.28.5
   - coverage==4.5.1

.travis_support/environments/tst_py36.yml

@@ -1,9 +1,11 @@
-name: pysharedmem_env
+name: pysharedmem_py36_env
 
 channels:
   - conda-forge
 
 dependencies:
+  - python=3.6.*
   - pip==18.0
   - wheel==0.31.1
+  - cython==0.28.5
   - coverage==4.5.1

MANIFEST.in

@@ -10,5 +10,7 @@ recursive-exclude * *.py[co]
 
 recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif
 
+include pyproject.toml
+
 include versioneer.py
-include pysharedmem/_version.py
+include _version.py

pysharedmem/_version.py → _version.py

@@ -43,7 +43,7 @@ def get_config():
     cfg.style = "pep440"
     cfg.tag_prefix = "v"
     cfg.parentdir_prefix = "pysharedmem"
-    cfg.versionfile_source = "pysharedmem/_version.py"
+    cfg.versionfile_source = "_version.py"
     cfg.verbose = False
     return cfg
 

docs/installation.rst

@@ -14,7 +14,7 @@ To install pysharedmem, run this command in your terminal:
 
     $ pip install pysharedmem
 
-This is the preferred method to install pysharedmem, as it will always install the most recent stable release. 
+This is the preferred method to install pysharedmem, as it will always install the most recent stable release.
 
 If you don't have `pip`_ installed, this `Python installation guide`_ can guide
 you through the process.

environment_doc.yml

@@ -4,6 +4,8 @@ channels:
   - conda-forge
 
 dependencies:
+  - python=3.6.*
   - pip==18.0
   - wheel==0.31.1
+  - cython==0.28.5
   - sphinx==1.7.5

pyproject.toml

@@ -0,0 +1,2 @@
+[build-system]
+requires = ["setuptools", "wheel", "cython"]

readthedocs.yml

@@ -1,2 +1,4 @@
 conda:
   file: environment_doc.yml
+python:
+  setup_py_install: true

setup.cfg

@@ -1,8 +1,8 @@
 [versioneer]
 VCS = git
 style = pep440
-versionfile_source = pysharedmem/_version.py
-versionfile_build = pysharedmem/_version.py
+versionfile_source = _version.py
+versionfile_build = _version.py
 tag_prefix = v
 parentdir_prefix = pysharedmem
 

setup.py

@@ -1,38 +1,121 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
+import glob
+import os
+import sys
+
 import setuptools
-from setuptools import setup
+from setuptools import setup, Extension
+
+from distutils.sysconfig import get_config_var, get_python_inc
+
 import versioneer
 
+version = versioneer.get_version()
 
 with open("README.rst") as readme_file:
     readme = readme_file.read()
 
 with open("HISTORY.rst") as history_file:
     history = history_file.read()
 
-requirements = [
+setup_requirements = [
+    "Cython>=0.28.5",
+]
+
+install_requirements = [
     # TODO: put package requirements here
 ]
 
 test_requirements = [
     # TODO: put package test requirements here
 ]
 
+cmdclasses = dict()
+cmdclasses.update(versioneer.get_cmdclass())
+
+if not (({"develop", "test"} & set(sys.argv)) or
+    any([v.startswith("build") for v in sys.argv]) or
+    any([v.startswith("bdist") for v in sys.argv]) or
+    any([v.startswith("install") for v in sys.argv])):
+    setup_requirements = []
+else:
+    with open("src/version.pxi", "w") as f:
+        f.writelines([
+            "__version__ = " + "\"" + str(version) + "\""
+        ])
+
+
+try:
+    i = sys.argv.index("test")
+    sys.argv = sys.argv[:i] + ["build_ext", "--inplace"] + sys.argv[i:]
+except ValueError:
+    pass
+
+
+include_dirs = [
+    os.path.dirname(get_python_inc()),
+    get_python_inc()
+]
+library_dirs = list(filter(
+    lambda v: v is not None,
+    [get_config_var("LIBDIR")]
+))
+
+headers = []
+sources = glob.glob("src/*.pxd") + glob.glob("src/*.pyx")
+libraries = []
+define_macros = []
+extra_compile_args = []
+cython_directives = {}
+cython_line_directives = {}
+
+
+if "test" in sys.argv:
+    cython_directives["binding"] = True
+    cython_directives["embedsignature"] = True
+    cython_directives["profile"] = True
+    cython_directives["linetrace"] = True
+    define_macros += [
+        ("CYTHON_PROFILE", 1),
+        ("CYTHON_TRACE", 1),
+        ("CYTHON_TRACE_NOGIL", 1),
+    ]
+
+
+ext_modules = [
+    Extension(
+        "pysharedmem",
+        sources=sources,
+        include_dirs=include_dirs,
+        library_dirs=library_dirs,
+        libraries=libraries,
+        define_macros=define_macros,
+        extra_compile_args=extra_compile_args,
+        language="c"
+    )
+]
+for em in ext_modules:
+    em.cython_directives = dict(cython_directives)
+    em.cython_line_directives = dict(cython_line_directives)
+
 
 setup(
     name="pysharedmem",
-    version=versioneer.get_version(),
+    version=version,
     description="Code for using interprocess shared memory in Python",
     long_description=readme + "\n\n" + history,
     author="John Kirkham",
     author_email="kirkhamj@janelia.hhmi.org",
     url="https://github.com/jakirkham/pysharedmem",
-    cmdclass=versioneer.get_cmdclass(),
+    cmdclass=cmdclasses,
     packages=setuptools.find_packages(exclude=["tests*"]),
     include_package_data=True,
-    install_requires=requirements,
+    setup_requires=setup_requirements,
+    install_requires=install_requirements,
+    headers=headers,
+    ext_modules=ext_modules,
     license="BSD 3-Clause",
     zip_safe=False,
     keywords="pysharedmem",

src/pysharedmem.pxd

@@ -0,0 +1 @@
+

src/pysharedmem.pyx

@@ -0,0 +1,3 @@
+cimport pysharedmem
+
+include "version.pxi"