README.rst

This is the standalone Sage Notebook.

Most of the notebook does not depend on having Sage installed. Only
a few miscellaneous functions are imported from Sage. We welcome help in
making the notebook completely independent from Sage, or indeed, any
other help with the Sage notebook. Sage notebook development discussions
happen on the sage-notebook mailing list.

Installation

Install Sage, then do sage -python setup.py install in the current
directory. Then run the notebook from within Sage as follows:

This will create a directory mynotebook.sagenb, and all notebook
data is stored in that directory.

SSL support

SSL is required for OpenID and HTTPS support in the notebook. OpenID
only requires Python's built-in SSL support, whereas HTTPS support also
requires the Python library pyOpenSSL. In order to ensure that these are
installed, please follow the instructions in Sage's own README file
(look for the section about SSL). If you don't intend to use OpenID for
user logins, or HTTPS for connecting to the server, you can safely
ignore this section. In particular, if you're installing a copy of Sage
for your personal use only, you probably won't need OpenID or HTTPS
support in the notebook.

Development

See the Sage Developer's guide, part of the Sage documentation, for
instructions.

Miscellaneous Release Instructions

The following advice for release managers of sagenb is taken from the
old SPKG.txt file that was sitting around. Most of it is probably
outdated, but here it is anyway. It is modified slightly to cause it to
make sense in some cases.

To cut a new release of sagenb, make sure that:

All changes are committed.

.gitignore and MANIFEST.in are current.

The notebook runs.

The doctests pass: sage -t --sagenb

The notebook will be possible to install from the new SPKG without
an internet connection.

Any dependencies that must be downloaded can be added in
util/fetch_deps.py and inserted in setup.py.
Dependencies of dependencies need not be put in setup.py,
but need to be put in util/fetch_deps.py (until we can make
it smarter).