v1.0.0

Time to tag a major release! The version number is written in Python in chirun/chirun_version.py, and available in the theme as CHIRUN_VERSION. The default theme shows the version in the footer.
chirun-ncl · Sep 28, 2023 · b4afc73 · b4afc73
1 parent 58884ac
commit b4afc73
Show file tree

Hide file tree

Showing 7 changed files with 12 additions and 7 deletions.
diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
@@ -1,4 +1,4 @@
-## E-Learning Unit, Newcastle University
+## Digital Learning Unit, Newcastle University
 
 * Christian Lawson-Perfect
 * Chris Graham

diff --git a/README.md b/README.md
@@ -31,7 +31,7 @@ Chirun can be used on Windows via [WSL](https://docs.microsoft.com/en-us/windows
 
 ### Demo
 
-[Sample course](https://www.chirun.org.uk/docs/en/latest/cli/install.html), and its [source code](https://github.com/chirun-ncl/sample_course).
+[Sample course](https://www.chirun.org.uk/demo), and its [source code](https://github.com/chirun-ncl/sample_course).
 
 ### Compile the Sample Course
  * Install the `chirun` package using the instructions above

diff --git a/chirun/chirun_version.py b/chirun/chirun_version.py
@@ -0,0 +1 @@
+VERSION = '1.0.0'
diff --git a/chirun/cli.py b/chirun/cli.py
@@ -1,3 +1,4 @@
+from . import chirun_version
 from . import mkdir_p
 from .item import load_item
 from . import process
@@ -20,6 +21,8 @@
 
 class Chirun:
 
+ VERSION = chirun_version.VERSION
+
  mathjax_url = 'https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js'
  processor_classes = [
  process.SlugCollisionProcess,

diff --git a/chirun/render.py b/chirun/render.py
@@ -153,6 +153,7 @@ def to_html(self, item, template_file, out_file=None):
  'item': item,
  'date': datetime.date.today(),
  'CHIRUN_HOME_URL': 'https://chirun.org.uk',
+ 'CHIRUN_VERSION': self.course.VERSION,
  'ACCESSIBILITY_STATEMENT_URL': 'https://chirun.org.uk/accessibility-statement/material',
  'out_file': out_file,
  }

diff --git a/chirun/themes/default/templates/footer.html b/chirun/themes/default/templates/footer.html
@@ -6,7 +6,7 @@
  </nav>
 
  <div id="footer-text">
- <p>{% trans url=CHIRUN_HOME_URL %}Generated using <a target="_blank" href="{{url}}">Chirun</a>, written by the Digital Learning Unit, School of Mathematics &amp; Statistics, Newcastle University{% endtrans %}</p>
+ <p>{% trans url=CHIRUN_HOME_URL, version=CHIRUN_VERSION %}Generated using <a target="_blank" href="{{url}}">Chirun</a> v{{CHIRUN_VERSION}}, written by the Digital Learning Unit, School of Mathematics &amp; Statistics, Newcastle University{% endtrans %}</p>
  <p>{% trans date=date %}This page last generated: {{date}}{% endtrans %}</p>
  </div>
 </footer>
diff --git a/setup.py b/setup.py
@@ -6,10 +6,10 @@
 
 setup(name="chirun",
  description="Produce flexible and accessible course notes, in a variety of formats, using LaTeX or Markdown source",
- version="0.8.0",
- author="E-Learning Team, School of Mathematics, Statistics & Physics, Newcastle University",
- author_email="christopher.graham@ncl.ac.uk",
- url="https://mas-coursebuild.ncl.ac.uk",
+ version="1.0.0",
+ author="Digital Learning Team, School of Mathematics, Statistics & Physics, Newcastle University",
+ author_email="msp.digital.learning@ncl.ac.uk",
+ url="https://chirun.org.uk",
  packages=find_packages(),
  include_package_data=True,
  scripts=['chirun/makecourse', 'chirun/chirun'],