#7784/sagenb: Add Makefile; update .hgignore and spkg-related files

Author: qed777

.hgignore

@@ -1,10 +1,4 @@
 # Boring file regexps:
-PKG-INFO
-push
-pull
-.cython_hash$
-.cython_deps$
-sagenb\.egg-info/
 \.git$
 \.hi$
 \.mtl$
@@ -54,83 +48,21 @@ sagenb\.egg-info/
 ^dist($|/)
 ^notes($|/)
 (^|/).old($|/)
-(^|/).tmp_pyrexembed($|/)
 (^|/).doctest($|/)
 (^|/)deleted($|/)
 ^build($|/)
-^changelog_darcs.txt($|/)
 ^mirror($|/)
 ^new($|/)
 ^commit($|/)
 ^export($|/)
-^sage/.*\.c$
-^sage/ext/arith.c$
-^sage/ext/arith_gmp.c$
-^sage/ext/coerce.c$
-^sage/ext/congroup_pyx.c$
-^sage/ext/dense_matrix_pyx.c$
-^sage/ext/element.c$
-^sage/ext/gens.c$
-^sage/ext/group.c$
-^sage/ext/heilbronn.c$
-^sage/ext/integer.c$
-^sage/ext/intmod_pyx.c$
-^sage/ext/module.c$
-^sage/ext/mpc.c$
-^sage/ext/mpfr.c$
-^sage/ext/p1list.c$
-^sage/ext/polynomial_pyx.c$
-^sage/ext/rational.c$
-^sage/ext/ring.c$
-^sage/ext/sage_object.c$
-^sage/ext/search.c$
-^sage/ext/sparse_matrix_pyx.c$
-^sage/ext/sparse_poly.c$
-^sage/libs/ec/ec.c$
-^sage/libs/hanke/hanke.c$
-^sage/libs/mwrank/mwrank.c$
-^sage/libs/ntl/ntl.c$
-^sage/libs/pari/gen.c$
-^sage/libs/pari/test.c$
-^sage/libs/.*/interrupt\.(h|pxi)$
-^sage/.doctest/err
-^sage/libs/cf/cf.pyx
-^sage/libs/cf/cf_embed.cpp
-^sage/libs/linbox/finite_field_givaro.cpp
-^sage/rings/finite_field_givaro.cpp
-version.py
-^c_lib/.deps/.*
-^c_lib/.libs/.*
-^c_lib/.*\.lo$
-^c_lib/.*\.os$
-^c_lib/Makefile$
-^c_lib/autom4te.cache/.*$
-^c_lib/config.log$
-^c_lib/config.status$
-^c_lib/libtool$
-^c_lib/libcsage.la$
-^sage/ext/interpreters/
-^sage/libs/ntl/misc.h$
-^sage/libs/ntl/ntl.h$
-^sage/rings/integer.h$
-^sage/rings/padics/padic_generic_element.h$
-^sage/rings/rational.h$
-^c_lib/.sconsign.dblite$
-^c_lib/libcsage.so$
-sage/rings/complex_double.h
-sage/rings/complex_double_api.h
-sage/misc/allocator.h
-sage/symbolic/pynac.h
-doc/output/*
-doc/en/reference/utils/*
-doc/en/reference/sage/*
-dotsage
 MANIFEST
-sagenb/data/jmol
-~
+PKG-INFO
+pull
+push
+release_notes.txt
 sage_notebook*
-.sagenb
-.*~$
-sagenb/data/java/jmol
+\.sagenb
 ^sass/src/.sass-cache
+sagenb/data/jmol
 ^sagenb.egg-info
+setup.cfg

MANIFEST.in

@@ -1,6 +1,6 @@
 recursive-include sagenb *
 recursive-include sass *
 prune sass/src/.sass-cache
-include *.txt MANIFEST.in .hgignore .hgtags sdist spkg-dist SPKG.txt go
+include *.txt Makefile MANIFEST.in .hgignore .hgtags sdist spkg-dist SPKG.txt go
 recursive-include .hg *
 global-exclude *.pyc *.pyo *.orig *.rej *~ \#* *\#

Makefile

@@ -0,0 +1,36 @@
+# -*- makefile -*-
+# Makefile for the Sage Notebook project (http://nb.sagemath.org/).
+# GNU make help: http://www.gnu.org/software/make/manual
+
+SAGE = sage
+HG = $(SAGE) -hg
+PYTHON = $(SAGE) -python
+SETUP = $(PYTHON) setup.py
+
+install:
+	$(SETUP) install
+
+develop:
+	$(SETUP) develop
+
+update:
+	$(HG) pull http://boxen.math.washington.edu:8100
+	$(HG) update
+
+doc:	doc-jsmath
+doc-pngmath:
+	$(SAGE) -docbuild reference html $(OPTS)
+doc-jsmath:
+	$(SAGE) -docbuild reference html -j $(OPTS)
+
+test:
+	$(SAGE) -t -sagenb $(OPTS)
+ptest:
+	$(SAGE) -tp \
+	`$(PYTHON) -c "import multiprocessing as m; print m.cpu_count()"` \
+	-sagenb $(OPTS)
+
+spkg:
+	./spkg-dist
+
+.PHONY:	clean distclean

SPKG.txt

@@ -5,26 +5,51 @@
 The Sage Notebook is a web-based graphical user interface for
 mathematical software.
 
-== Website ==
-
 == License ==
 
 GPLv2+
 
 == SPKG Maintainers ==
 
  * William Stein
+ * Tim Dumol
+ * Mitesh Patel
 
 == Upstream Contact ==
 
  * William Stein
+ * Homepage: http://nb.sagemath.org/
 
 == Dependencies ==
- * Python 2.6 (?) or later -- only tested with 2.6
 
-== Special Update/Build Instructions ==
+ * Python >= 2.6
+ * jinja2 >= 2.1.1
+ * Twisted >= 8.2
+ * zope.testbrowser >= 3.7.0a1 (included)
+ * Sphinx >= 0.6.3 (pretty docstrings)
+
+== Special Update / Build Instructions ==
+
+ * To release a new spkg, check that
+
+   * All changes are committed.
+   * .hgignore and MANIFEST.in are current.
+   * The patch queue is clear.
+   * The notebook runs.
+   * The doctests pass: sage -t -sagenb
+   * The Selenium tests pass (optional, for now).
+
+   Then,
+
+   * Update the version in setup.py and commit this change.
+   * Run spkg-dist.
+   * Install and test the new spkg: sage -f dist/sagenb-*.spkg
+
+   Contact a maintainer about pushing updates to the public Mercurial
+   repository.
 
- * None
+ * Stylesheets (CSS): see sass/readme.txt.
 
 == Changelog ==
 
+ * For an accurate log of changes, run "hg log" in src/sagenb.

sdist

@@ -1,3 +1,12 @@
-hg ci && sage -python setup.py sdist
+#!/bin/bash
+set -e
 
-./push
+sage -hg ci
+
+sage -python setup.py sdist
+
+echo "**********************************************************"
+echo "* If this is an official SageNB release, don't forget to *"
+echo "* push the changes to the public Mercurial repository.   *"
+echo "**********************************************************"
+#./push

spkg-dist

@@ -1,41 +1,48 @@
 #!/usr/bin/env python
-import os, shutil, sys, tarfile
+# Create a new Sage Notebook spkg.
+
+import os
+import sys
+import stat
+import shutil
+import tarfile
+import subprocess
 from tempfile import mkdtemp
 
 from pkg_resources import Requirement
 from setuptools.package_index import PackageIndex
-# Create an spkg of the Separated Sage notebook for inclusion in Sage.
 
-# Get the version from setup.py
+# Get the version from setup.py.
 version_line = [f for f in open('setup.py').readlines() if 'version' in f][0]
 i = version_line.find("'")
 j = version_line.rfind("'")
-version = version_line[i+1:j]
+version = version_line[i + 1:j]
 
-# Create the sdist
+# Create the source distribution.
+proc = subprocess.Popen([os.path.join(os.path.curdir, 'sdist')], shell=True)
+if proc.wait():
+    print "Uncommitted changes in repository.  Stopping."
+    sys.exit(1)
 
-os.system(os.path.join(os.path.curdir, 'sdist'))
-
-# Create the spkg
-
-path = os.path.join('dist','sagenb-%s'%version)
+# Create the spkg.
+base = 'sagenb-%s' % version
+path = os.path.join('dist', base)
 if os.path.exists(path):
     shutil.rmtree(path)
-
 os.makedirs(path)
 
-file = 'sagenb-%s.tar.gz'%version
-print "Extracting %s"%file
+file = 'sagenb-%s.tar.gz' % version
+print "Extracting %s" % file
 t = tarfile.open(os.path.join('dist', file))
-
 t.extractall(path)
 
 os.chdir(path)
 os.mkdir('src')
-shutil.move('sagenb-%s'%version, 'src/sagenb')
+shutil.move(base, os.path.join('src', 'sagenb'))
 
-spkg_install_fd = open('spkg-install','w')
-spkg_install_fd.write("cd src; ")
+spkg_install = os.path.abspath(os.path.join(os.path.curdir, 'spkg-install'))
+spkg_install_fd = open(spkg_install, 'w')
+spkg_install_fd.write("cd src\n")
 
 shutil.copy(os.path.join(os.path.pardir, os.path.pardir, 'SPKG.txt'),
             os.path.curdir)
@@ -44,24 +51,34 @@ print "Fetching the required packages"
 pkg_index = PackageIndex()
 
 tmp_dir = mkdtemp()
-required_packages = ('pytz>=2009r', 'zope.i18nmessageid>=3.5', 'zope.event>=3.4.1',
-                     'ClientForm>=0.2.10', 'mechanize>=0.1.11', 'zope.interface>=3.3.0',
-                     'zope.schema>=3.5.4', 'zope.testbrowser>=3.7.0a1')
+required_packages = ('pytz>=2009r',
+                     'zope.i18nmessageid>=3.5',
+                     'zope.event>=3.4.1',
+                     'ClientForm>=0.2.10',
+                     'mechanize>=0.1.11',
+                     'zope.interface>=3.3.0',
+                     'zope.schema>=3.5.4',
+                     'zope.testbrowser>=3.7.0a1')
+
 pkg_locations = []
 
 for pkg in required_packages:
     print "Fetching %s" % pkg
-    dist = pkg_index.fetch_distribution(Requirement.parse(pkg), tmp_dir, True, True)
+    dist = pkg_index.fetch_distribution(Requirement.parse(pkg), tmp_dir,
+                                        True, True)
     pkg_locations.append(os.path.abspath(dist.location))
 
 for location in pkg_locations:
     shutil.copy(location, 'src')
-    spkg_install_fd.write('easy_install %s; ' % os.path.basename(location))
+    spkg_install_fd.write('easy_install %s\n' % os.path.basename(location))
 
 os.chdir(os.path.pardir)
 
-spkg_install_fd.write('cd sagenb; python setup.py install')
+spkg_install_fd.write('cd sagenb\n')
+spkg_install_fd.write('python setup.py install\n')
 spkg_install_fd.close()
+os.chmod(spkg_install, stat.S_IRWXU | stat.S_IRGRP | stat.S_IXGRP |
+         stat.S_IROTH | stat.S_IXOTH)
 shutil.rmtree(tmp_dir)
-os.system('sage -pkg sagenb-%s'%version)
 
+subprocess.call(['sage -pkg ' + base], shell=True)