Added support for cython, also added dependency on sagemath package.

Author: mmasdeu

.travis-test.sh

@@ -4,6 +4,7 @@
 # notice and this notice are preserved.  This file is offered as-is,
 # without any warranty.
 set -e
+$HOME/SageMath/sage -pip install --upgrade --no-index -v sagemath # Check that Sage is installed
 $HOME/SageMath/sage -pip install --upgrade --no-index -v .
 $HOME/SageMath/sage setup.py test
 (cd docs && $HOME/SageMath/sage -sh -c "make html")

.travis.yml

@@ -5,7 +5,9 @@
 language: python
 matrix:
   include:
-  - env: CACHE_NAME=7.6 DEPLOY_DOC_FROM_BRANCH=master DEPLOY_DOC_TO_DIRECTORY=/ SAGE_SERVER=http://mirrors.xmission.com/sage/ SAGE_IMAGE=linux/64bit/sage-7.6-Ubuntu_12.04-x86_64.tar.bz2
+  - env: CACHE_NAME=7.6 DEPLOY_DOC_FROM_BRANCH=master DEPLOY_DOC_TO_REPOSITORY=username/sample_sage
+     DEPLOY_DOC_TO_DIRECTORY=doc/html SAGE_SERVER=http://mirrors.xmission.com/sage/ SAGE_IMAGE=linux/64bit/sage-7.6-Ubuntu_12.04-x86_64.tar.bz2
+  allow_failures:
   - env: CACHE_NAME=7.5.1 SAGE_SERVER=http://mirrors.xmission.com/sage/ SAGE_IMAGE=linux/64bit/sage-7.5.1-Ubuntu_12.04-x86_64.tar.bz2
 install:
 - ./.travis-install.sh

README.rst

@@ -47,7 +47,7 @@ Setup
 ------
 
 All packaging setup is done through ``setup.py``. To create your own package
-follow the strcuture of the file and change the parameters accordingly.
+follow the structure of the file and change the parameters accordingly.
 
 Source code
 -----------
@@ -120,14 +120,14 @@ versions used.
 Automatically deploying documentation to GitHub pages using Travis CI
 ---------------------------------------------------------------------
 
- * First do the steps described above to enable Travis CI integration
-   of your GitHub-hosted project.
-   
- * If you don't already have GitHub pages for your project: Create and
-   checkout a branch ``gh-pages`` in your repository and put an empty
-   file ``.nojekyll`` in it.  (See
-   https://help.github.com/articles/files-that-start-with-an-underscore-are-missing/)::
-   Commit it and push it to GitHub::
+* First do the steps described above to enable Travis CI integration
+  of your GitHub-hosted project.
+
+* If you don't already have GitHub pages for your project: Create and
+  checkout a branch ``gh-pages`` in your repository and put an empty
+  file ``.nojekyll`` in it.  (See
+  https://help.github.com/articles/files-that-start-with-an-underscore-are-missing/)::
+  Commit it and push it to GitHub::
 
     $ git clone --single-branch --depth 1 https://github.com/USER/PROJECT.git gh-pages
     $ cd gh-pages
@@ -138,58 +138,58 @@ Automatically deploying documentation to GitHub pages using Travis CI
     $ git commit -m "Initial commit"
     $ git push -u origin gh-pages
     $ cd ..
-    
- * (Back in your working copy:) Generate a new ssh key pair with an
-   empty passphrase::
+
+* (Back in your working copy:) Generate a new ssh key pair with an
+  empty passphrase::
 
     $ ssh-keygen -t dsa -f .travis_ci_gh_pages_deploy_key
 
- * Add the public ssh key (contents of the file
-   ``.travis_ci_gh_pages_deploy_key.pub``) to your GitHub repository
-   as a deploy key (Settings/Deploy keys/Add deploy key).
-   Title: Key for deploying documentation to GitHub pages.
-   Check Allow write access.
+* Add the public ssh key (contents of the file
+  ``.travis_ci_gh_pages_deploy_key.pub``) to your GitHub repository
+  as a deploy key (Settings/Deploy keys/Add deploy key).
+  Title: Key for deploying documentation to GitHub pages.
+  Check Allow write access.
 
- * Install the Travis CI command-line client from
-   https://github.com/travis-ci/travis.rb::
+* Install the Travis CI command-line client from
+  https://github.com/travis-ci/travis.rb::
 
     $ gem install travis
-   
- * Log in to Travis CI using your GitHub credentials::
+
+* Log in to Travis CI using your GitHub credentials::
 
     $ travis login
-   
- * Encrypt the private ssh key, add the decryption keys
-   as secure environment variables to Travis CI, and
-   add code to ``.travis.yml`` to decrypt it::
+
+* Encrypt the private ssh key, add the decryption keys
+  as secure environment variables to Travis CI, and
+  add code to ``.travis.yml`` to decrypt it::
 
     $ travis encrypt-file .travis_ci_gh_pages_deploy_key --add before_script
 
- * Add the encrypted private ssh key to the repository::
+* Add the encrypted private ssh key to the repository::
 
     $ git add .travis_ci_gh_pages_deploy_key.enc
 
- * Have git ignore the other keys (and the gh-pages directory)::
+* Have git ignore the other keys (and the gh-pages directory)::
 
     $ echo >> .gitignore
     $ echo "/.travis_ci_gh_pages_deploy_key" >> .gitignore
     $ echo "/.travis_ci_gh_pages_deploy_key.pub" >> .gitignore
     $ echo "/gh-pages" >> .gitignore
     $ git add .gitignore
 
- * Optionally, edit ``.travis.yml`` to adjust variables ``DEPLOY_DOC_...``
+* Optionally, edit ``.travis.yml`` to adjust variables ``DEPLOY_DOC_...``
 
- * Commit all changes to GitHub.  The Travis CI build should then run
-   automatically and deploy it::
+* Commit all changes to GitHub.  The Travis CI build should then run
+  automatically and deploy it::
 
     $ git add .travis.yml
     $ git commit -m "Deploy built documentation to GitHub"
     $ git push
- 
- * The deployed documentation will be available at:
-   https://USER.github.io/PROJECT/
-   This can be customized by changing ``DEPLOY_DOC_TO_DIRECTORY=/``
-   to another directory in ``.travis.yml``
-   For example, setting ``DEPLOY_DOC_TO_DIRECTORY=doc/html`` will make
-   the deployed documentation available at:
-   https://USER.github.io/PROJECT/doc/html/
+
+* The deployed documentation will be available at:
+  https://USER.github.io/PROJECT/
+  This can be customized by changing ``DEPLOY_DOC_TO_DIRECTORY=/``
+  to another directory in ``.travis.yml``
+  For example, setting ``DEPLOY_DOC_TO_DIRECTORY=doc/html`` will make
+  the deployed documentation available at:
+  https://USER.github.io/PROJECT/doc/html/

sage_sample/ultimate_question.py

@@ -23,6 +23,7 @@
 - Viviane Pons: initial implementation
 """
 from sage.combinat.combinat import catalan_number
+from one_cython_file import quick_question
 
 def answer_to_ultimate_question():
     r"""
@@ -42,4 +43,4 @@ def answer_to_ultimate_question():
         sage: answer_to_ultimate_question() == 42
         True
     """
-    return catalan_number(5)
+    return quick_question(catalan_number(5)) - 1

setup.py

@@ -4,20 +4,43 @@
 from setuptools import setup
 from codecs import open # To open the README file with proper encoding
 from setuptools.command.test import test as TestCommand # for tests
+from distutils.command import build as build_module
 
+# The next block is needed if there are cython files
+from setuptools import Extension
+from Cython.Build import cythonize
+import Cython.Compiler.Options
+from sage.env import sage_include_directories
 
 # Get information from separate files (README, VERSION)
 def readfile(filename):
     with open(filename,  encoding='utf-8') as f:
         return f.read()
 
+# Check the right Sage version
+class build(build_module.build):
+    def run(self):
+        from sagemath.check_version import check_version
+        check_version(sage_required_version)
+        build_module.build.run(self)
+
 # For the tests
 class SageTest(TestCommand):
     def run_tests(self):
         errno = os.system("sage -t --force-lib sage_sample")
         if errno != 0:
             sys.exit(1)
 
+# Cython modules
+ext_modules = [
+         Extension('sage_sample.one_cython_file',
+         sources = [os.path.join('sage_sample','one_cython_file.pyx')],
+         include_dirs=sage_include_directories())
+]
+
+# Specify the required Sage version
+sage_required_version = '>=7.6'
+
 setup(
     name = "sage_sample",
     version = readfile("VERSION"), # the VERSION file is shared with the documentation
@@ -40,6 +63,8 @@ def run_tests(self):
       'Programming Language :: Python :: 2.7',
     ], # classifiers list: https://pypi.python.org/pypi?%3Aaction=list_classifiers
     keywords = "SageMath packaging",
+    install_requires = ['sagemath'], # This ensures that Sage is installed
     packages = ['sage_sample'],
-    cmdclass = {'test': SageTest} # adding a special setup command for tests
+    ext_modules = cytonize(ext_modules), # This line is only needed if there are cython files present
+    cmdclass = {'build': build, 'test': SageTest} # adding a special setup command for tests
 )