csv-metadata-quality-web/templates/index.html

<!doctype html>
<html lang="en" class="h-100">
  {% include 'head.html' %}
  <body class="d-flex flex-column h-100">
    {% include 'header.html' %}
    <main class="flex-shrink-0">
      <div class="container py-3">
        <p class="lead">The DSpace CSV Metadata Quality Checker is a collection of sanity checks and automated fixes for a number of common issues in metadata files.</p>
        <form method="POST" action="" enctype="multipart/form-data">
          <div class="mb-3">
            <label for="formFile" class="form-label">Select a CSV file to process</label>
            <input class="form-control" type="file" id="formFile" name="file" accept=".csv">
          </div>

          <div class="input-group mb-3">
            <div class="input-group-text">
              Skip fields(s)&nbsp;
              <input class="form-check-input" type="checkbox" id="excludeFieldsCheckbox" name="excludeCheckbox" aria-label="Checkbox for following text input">
            </div>
            <input type="text" class="form-control" placeholder="dcterms.subject" id="excludeFieldsText" name="excludeText" aria-label="Text input with checkbox">
            <div id="excludeHelp" class="form-text">Optionally indicate fields to skip during analysis. Separate multiple fields with a comma, for example: <code>dcterms.issued,dcterms.subject</code>.</div>
          </div>

          <div class="mb-3 form-check form-switch">
            <input class="form-check-input" type="checkbox" id="unsafeCheckbox" name="unsafe">
            <label class="form-check-label" for="unsafeCheckbox" aria-describedby="unsafeHelp">Enable unsafe fixes</label>
            <div id="unsafeHelp" class="form-text">This will remove newlines and perform <a href="https://withblue.ink/2019/03/11/why-you-need-to-normalize-unicode-strings.html" title='When "Zoë" !== "Zoë". Or why you need to normalize Unicode strings'>normalization of Unicode characters</a>. Read more about these <a href="https://github.com/ilri/csv-metadata-quality#unsafe-fixes">unsafe fixes</a>.</div>
          </div>

          <div class="mb-3 form-check form-switch">
            <input class="form-check-input" type="checkbox" id="experimentalCheckbox" name="experimental">
            <label class="form-check-label" for="experimentalCheckbox" aria-describedby="experimentalHelp">Enable experimental checks</label>
            <div id="experimentalHelp" class="form-text">Attempt to validate whether the value of an item's <code>dc.language.iso</code> or <code>dcterms.language</code> field matches the <em>actual</em> language of text used in its title, abstract, and citation. Read more about these <a href="https://github.com/ilri/csv-metadata-quality#experimental-checks">experimental checks</a>.</div>
          </div>

          <button type="submit" class="btn btn-primary">Submit</button>
        </form>
      </div>
    </main>

    {% include 'footer.html' %}
  </body>
</html>
Add simple HTML template with file upload Code taken from the following blog posts: - https://pythonbasics.org/flask-upload-file - https://blog.miguelgrinberg.com/post/handling-file-uploads-with-flask 2021-03-11 14:55:58 +01:00			`<!doctype html>`
templates/index.html: Improve layout Based on the Bootstrap v5.0-beta2 sticky footer example. See: https://getbootstrap.com/docs/5.0/examples/sticky-footer/ 2021-03-11 19:28:42 +01:00			`<html lang="en" class="h-100">`
Split index.html template into header, index, and footer 2021-03-11 21:41:22 +01:00			`{% include 'head.html' %}`
templates/index.html: Improve layout Based on the Bootstrap v5.0-beta2 sticky footer example. See: https://getbootstrap.com/docs/5.0/examples/sticky-footer/ 2021-03-11 19:28:42 +01:00			`<body class="d-flex flex-column h-100">`
Major refactor Refactor the templates to include a header, use csv-metadata-quality in a subshell instead of trying to import and pass args to it (which I actually managed to do, but then trying to capture the output was an issue), and use ansi2html to prepare the CLI output as the HTML. 2021-03-12 18:14:49 +01:00			`{% include 'header.html' %}`
templates/index.html: Improve layout Based on the Bootstrap v5.0-beta2 sticky footer example. See: https://getbootstrap.com/docs/5.0/examples/sticky-footer/ 2021-03-11 19:28:42 +01:00			`<main class="flex-shrink-0">`
Major refactor Refactor the templates to include a header, use csv-metadata-quality in a subshell instead of trying to import and pass args to it (which I actually managed to do, but then trying to capture the output was an issue), and use ansi2html to prepare the CLI output as the HTML. 2021-03-12 18:14:49 +01:00			`<div class="container py-3">`
Major refactor Re-work upload and file processing so they are in the same Python function. Now I will start exposing other command line options in the form, like unsafe fixes, excluding fields, etc. Now I see tha t it is easier to save the POSTed file and process it in the same function so I don't have to pass around the other POSTed form val ues as URL query parameters. Now, as a result of changing the flow above, I also had to make a change to the way I show the results page. Instead of processing the file and returning the rendered results to the user directly, I process the file, save the rendered results to /tmp, and return a redirect to the user to the results page. 2021-03-13 21:11:26 +01:00			`<p class="lead">The DSpace CSV Metadata Quality Checker is a collection of sanity checks and automated fixes for a number of common issues in metadata files.</p>`
templates/index.html: Improve layout Based on the Bootstrap v5.0-beta2 sticky footer example. See: https://getbootstrap.com/docs/5.0/examples/sticky-footer/ 2021-03-11 19:28:42 +01:00			`<form method="POST" action="" enctype="multipart/form-data">`
templates/index.html: Use Bootstrap form components 2021-03-13 12:50:46 +01:00			`<div class="mb-3">`
			`<label for="formFile" class="form-label">Select a CSV file to process</label>`
			`<input class="form-control" type="file" id="formFile" name="file" accept=".csv">`
			`</div>`

Add support for skipping fields ("-x") 2021-03-13 22:34:11 +01:00			`<div class="input-group mb-3">`
			`<div class="input-group-text">`
			`Skip fields(s) `
			`<input class="form-check-input" type="checkbox" id="excludeFieldsCheckbox" name="excludeCheckbox" aria-label="Checkbox for following text input">`
			`</div>`
			`<input type="text" class="form-control" placeholder="dcterms.subject" id="excludeFieldsText" name="excludeText" aria-label="Text input with checkbox">`
			`<div id="excludeHelp" class="form-text">Optionally indicate fields to skip during analysis. Separate multiple fields with a comma, for example: <code>dcterms.issued,dcterms.subject</code>.</div>`
			`</div>`

Major refactor Re-work upload and file processing so they are in the same Python function. Now I will start exposing other command line options in the form, like unsafe fixes, excluding fields, etc. Now I see tha t it is easier to save the POSTed file and process it in the same function so I don't have to pass around the other POSTed form val ues as URL query parameters. Now, as a result of changing the flow above, I also had to make a change to the way I show the results page. Instead of processing the file and returning the rendered results to the user directly, I process the file, save the rendered results to /tmp, and return a redirect to the user to the results page. 2021-03-13 21:11:26 +01:00			`<div class="mb-3 form-check form-switch">`
			`<input class="form-check-input" type="checkbox" id="unsafeCheckbox" name="unsafe">`
			`<label class="form-check-label" for="unsafeCheckbox" aria-describedby="unsafeHelp">Enable unsafe fixes</label>`
			`<div id="unsafeHelp" class="form-text">This will remove newlines and perform <a href="https://withblue.ink/2019/03/11/why-you-need-to-normalize-unicode-strings.html" title='When "Zoë" !== "Zoë". Or why you need to normalize Unicode strings'>normalization of Unicode characters</a>. Read more about these <a href="https://github.com/ilri/csv-metadata-quality#unsafe-fixes">unsafe fixes</a>.</div>`
			`</div>`

Add support for experimental checks ("-e") 2021-03-13 22:01:11 +01:00			`<div class="mb-3 form-check form-switch">`
			`<input class="form-check-input" type="checkbox" id="experimentalCheckbox" name="experimental">`
			`<label class="form-check-label" for="experimentalCheckbox" aria-describedby="experimentalHelp">Enable experimental checks</label>`
			`<div id="experimentalHelp" class="form-text">Attempt to validate whether the value of an item's <code>dc.language.iso</code> or <code>dcterms.language</code> field matches the <em>actual</em> language of text used in its title, abstract, and citation. Read more about these <a href="https://github.com/ilri/csv-metadata-quality#experimental-checks">experimental checks</a>.</div>`
			`</div>`

templates/index.html: Use Bootstrap form components 2021-03-13 12:50:46 +01:00			`<button type="submit" class="btn btn-primary">Submit</button>`
templates/index.html: Improve layout Based on the Bootstrap v5.0-beta2 sticky footer example. See: https://getbootstrap.com/docs/5.0/examples/sticky-footer/ 2021-03-11 19:28:42 +01:00			`</form>`
			`</div>`
			`</main>`

Split index.html template into header, index, and footer 2021-03-11 21:41:22 +01:00			`{% include 'footer.html' %}`
Add simple HTML template with file upload Code taken from the following blog posts: - https://pythonbasics.org/flask-upload-file - https://blog.miguelgrinberg.com/post/handling-file-uploads-with-flask 2021-03-11 14:55:58 +01:00			`</body>`
			`</html>`