Source code for signac_dashboard.modules.notes

# Copyright (c) 2019 The Regents of the University of Michigan
# All rights reserved.
# This software is licensed under the BSD 3-Clause License.
from signac_dashboard.module import Module
from flask import render_template, request, abort
from jinja2.exceptions import TemplateNotFound

[docs]class Notes(Module): """Displays a text box that is synced to the job document. The contents of the text box are saved to :code:`job.document['notes']`. The Notes module can be used to annotate a large data space with tags or human-readable descriptions for post-processing, parsing, or searching. :param key: Document key to display and update (default: :code:`'notes'`). :type key: str """ def __init__(self, name='Notes', context='JobContext', template='cards/notes.html', key='notes', **kwargs): super().__init__(name=name, context=context, template=template, **kwargs) self.key = key def get_cards(self, job): note_text = job.document.get(self.key, '') return [{'name':, 'content': render_template( self.template, note_text=note_text, jobid=job._id)}] def register(self, dashboard): # Register routes'/module/notes/update', methods=['POST']) def notes_update(): note_text = request.form.get('note_text') jobid = request.form.get('jobid') job = dashboard.project.open_job(id=jobid) job.document[self.key] = note_text return "Saved."'/module/notes/<path:filename>') def notes_asset(filename): path = 'notes/{}'.format(filename) try: return render_template(path) except TemplateNotFound: abort(404, 'The file requested does not exist.') # Register assets assets = ['js/notes.js'] for assetfile in assets: dashboard.register_module_asset({ 'file': 'templates/notes/{}'.format(assetfile), 'url': '/module/notes/{}'.format(assetfile) })