Website for course materials
Project description
naucse
This is a server for open course material.
To use it, you will need some content.
Usually, the repository with the content will require naucse
module,
and will run using python -m naucse
.
We use content at https://github.com/pyvec/naucse.python.cz to generate naucse.python.cz.
Installation
Install from a virtual environment (or a tool like pipenv).
To install the latest release:
(venv)$ python -m pip install naucse
To install from a cloned repository:
(venv)$ python -m pip install -e.
Running
To run the serve, either change (cd
) to the directory with content,
or set NAUCSE_ROOT_PATH
to that directory.
Then run:
(venv)$ python -m naucse serve
Instead of serve
, you can run freeze
to generate a static website.
See Elsa for other usage, including
deployment to GitHub Pages.
External courses
Courses may be rendered from external repositories.
This is a security risk, so such courses are disabled by default.
Set NAUCSE_TRUSTED_REPOS
to a space-separated globs of repository URLs
to allow. The URLS have a #branch
fragment.
In an isolated environment, you can set NAUCSE_TRUSTED_REPOS
to *
Tests
Tests can be run using tox
:
$ tox
Licence
The code is licensed under the terms of the MIT license, see LICENSE.MIT file for full text. By contributing code to this repository, you agree to have it licensed under the same license.
Content has its own license specified in the appropriate matadata. Only free content licenses are used. By contributing to an already licensed document, you agree to have it licensed under the same license. (And feel free to add yourself to the authors list in its metadata.) When contributing new document(s) a license must be specified in the metadata.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.