documentation site

Author: sheppard

README.md

@@ -0,0 +1,8 @@
+---
+layout: null
+---
+{{ site.pages
+   | where_exp:"p","p.dir == page.dir"
+   | where_exp:"p","p.name != page.name"
+   | where_exp:"p","p.name != 'index.md'"
+   | jsonify }}

docs/@wq/$index.json

@@ -0,0 +1,16 @@
+---
+permalink: /@wq/
+wq_config:
+  name: npmpackage
+  url: "@wq"
+  order: 31
+  section: Packages
+  icon_data: "M12,1.85C11.73,1.85 11.45,1.92 11.22,2.05L3.78,6.35C3.3,6.63 3,7.15 3,7.71V16.29C3,16.85 3.3,17.37 3.78,17.65L5.73,18.77C6.68,19.23 7,19.24 7.44,19.24C8.84,19.24 9.65,18.39 9.65,16.91V8.44C9.65,8.32 9.55,8.22 9.43,8.22H8.5C8.37,8.22 8.27,8.32 8.27,8.44V16.91C8.27,17.57 7.59,18.22 6.5,17.67L4.45,16.5C4.38,16.45 4.34,16.37 4.34,16.29V7.71C4.34,7.62 4.38,7.54 4.45,7.5L11.89,3.21C11.95,3.17 12.05,3.17 12.11,3.21L19.55,7.5C19.62,7.54 19.66,7.62 19.66,7.71V16.29C19.66,16.37 19.62,16.45 19.55,16.5L12.11,20.79C12.05,20.83 11.95,20.83 11.88,20.79L10,19.65C9.92,19.62 9.84,19.61 9.79,19.64C9.26,19.94 9.16,20 8.67,20.15C8.55,20.19 8.36,20.26 8.74,20.47L11.22,21.94C11.46,22.08 11.72,22.15 12,22.15C12.28,22.15 12.54,22.08 12.78,21.94L20.22,17.65C20.7,17.37 21,16.85 21,16.29V7.71C21,7.15 20.7,6.63 20.22,6.35L12.78,2.05C12.55,1.92 12.28,1.85 12,1.85M14,8C11.88,8 10.61,8.89 10.61,10.39C10.61,12 11.87,12.47 13.91,12.67C16.34,12.91 16.53,13.27 16.53,13.75C16.53,14.58 15.86,14.93 14.3,14.93C12.32,14.93 11.9,14.44 11.75,13.46C11.73,13.36 11.64,13.28 11.53,13.28H10.57C10.45,13.28 10.36,13.37 10.36,13.5C10.36,14.74 11.04,16.24 14.3,16.24C16.65,16.24 18,15.31 18,13.69C18,12.08 16.92,11.66 14.63,11.35C12.32,11.05 12.09,10.89 12.09,10.35C12.09,9.9 12.29,9.3 14,9.3C15.5,9.3 16.09,9.63 16.32,10.66C16.34,10.76 16.43,10.83 16.53,10.83H17.5C17.55,10.83 17.61,10.81 17.65,10.76C17.69,10.72 17.72,10.66 17.7,10.6C17.56,8.82 16.38,8 14,8Z"
+---
+
+# npm Packages
+
+Django Data Wizard project provides the following packages [on npm][npm].  (Also see the list of [core @wq packages][core]).
+
+[npm]: https://www.npmjs.com/org/wq
+[core]: https://wq.io/@wq/

docs/@wq/index.md

@@ -0,0 +1,40 @@
+---
+title: "@wq/progress-element"
+module: Django Data Wizard
+---
+
+![@wq/progress-element](../images/@wq/progress-element.svg)
+
+**@wq/progress-element** provides a simple way to create fetch()-powered auto-updating HTML5 [progress] elements. @wq/progress-element is meant to be used with a JSON web service that provides updates as to the current status of a long-running task. @wq/progress-element is primarily intended for (and bundled with) the [Django Data Wizard] package.
+
+## Installation
+
+```bash
+npm install @wq/progress-element
+```
+
+> Note: @wq/progress-element is designed for Django Data Wizard's Admin-style UI, and is enabled automatically by default. If you are using a wq framework / React UI, use [@wq/wizard] rather than @wq/progress-element.
+
+#### API
+
+@wq/progress-element scans the page for `<progress>` elements during initialization, and can be configured via `data-wq-*` attributes.
+
+-   `data-wq-url` configures the URL to use for the AJAX request to update the progress status.
+-   `data-wq-interval` defines the polling frequency in seconds (default 0.5).
+-   `data-wq-status` can be used to specify an element which will be used to display `error` or `message` attributes from the JSON response.
+
+```xml
+<progress data-wq-url="/getstatus.json"
+          data-wq-interval=0.25
+          data-wq-status="status-info"></progress>
+<div id="status-info"></div>
+```
+
+For older browsers, the `<progress>` bar will automatically fall back to text showing the current status.
+
+@wq/progress-element automatically configures a [@wq/progress] client to start polling the web service. See [@wq/progress] for more details on the expected data structure.
+
+[progress]: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress
+[Django Data Wizard]: ../index.md
+[@wq/wizard]: ./wizard.md
+[@wq/progress]: ./progress.md

docs/@wq/progress-element.md

@@ -0,0 +1,47 @@
+---
+title: "@wq/progress"
+module: Django Data Wizard
+---
+
+![@wq/progress](../images/@wq/progress.svg)
+
+**@wq/progress** provides a simple API client for auto-updating [progress] elements. @wq/progress is meant to be used with a JSON web service that provides updates as to the current status of a long-running task, such as the data import tasks in the [Django Data Wizard] package.
+
+> Note: The jQuery and HTML `<progress>` integration has moved to a separate package, [@wq/progress-element]. wq framework / React UI integration is provided by [@wq/wizard].
+
+## Installation
+
+```bash
+npm install @wq/progress
+```
+
+#### API
+
+@wq/progress should be configured with a url and polling interval, as well as up to three custom callback functions (`onComplete`, `onFail`, and `onProgress`). The callback functions will be passed the most recent JSON data from the web service.
+
+```javascript
+// src/index.js
+import { Progress } from '@wq/progress';
+
+const progress = new Progress({
+    url: 'http://some-web-service/',
+    interval: 0.5,
+    onProgress(data) {
+        console.log(data);
+    },
+});
+
+progress.start();
+```
+
+@wq/progress assumes a specific structure for the data from the web service. The following attributes should be specified on the returned JSON object:
+
+-   `total`: the total number of items being processed
+-   `current`: the rank of the currently processing item. (`current / total` will be used to determine the % complete)
+-   `status`: A text status indicating task state. A status of `"SUCCESS"` or `"FAILURE"` will cause polling to cease and the `onComplete` or `onFailure` callbacks to be called. The status names were originally based on [Celery's state names][celery-states], though Celery is no longer required for [Django Data Wizard].
+-   `error` or `message`: Will be displayed with the `data-wq-status` option.
+
+[Django Data Wizard]: ../index.md
+[@wq/progress-element]: ./progress-element.md
+[@wq/wizard]: ./wizard.md
+[celery-states]: http://docs.celeryproject.org/en/latest/userguide/tasks.html#states

docs/@wq/progress.md

@@ -0,0 +1,54 @@
+---
+title: "@wq/wizard"
+module: Django Data Wizard
+---
+
+![@wq/wizard](../images/@wq/wizard.svg)
+
+**@wq/wizard** is a [@wq/app plugin][plugins] providing a complete React UI for the [Django Data Wizard] package.
+
+## Installation
+
+### wq.app for PyPI
+
+When using Django Data Wizard together with [wq.app]'s [wq.js] build, update app/js/{project_name}.js to import and register wizard.js, which is provided by data_wizard's static/app/js directory.
+
+```bash
+pip install wq.app data-wizard
+```
+
+```javascript
+import wq from './wq.js';
+import config from './data/config.js';
+import wizard from './wizard.js';
+
+wq.use([wizard]);
+
+wq.init(config).then(...);
+```
+
+### @wq/app for npm
+
+When using @wq/app for npm, install and import the @wq/wizard npm package.
+
+```bash
+npm install @wq/wizard
+```
+
+```javascript
+import app from '@wq/app';
+import material from '@wq/material';
+import mapgl from '@wq/map-gl';
+import wizard from '@wq/wizard';
+import config from './config';
+
+app.use([material, mapgl, wizard]);
+
+app.init(config).then(...);
+```
+
+[plugins]: https://wq.io/plugins/
+[Django Data Wizard]: ../index.md
+[wq.app]: https://wq.io/wq.app/
+[wq.js]: https://wq.io/wq
+[@wq/app]: https://wq.io/@wq/app

docs/@wq/wizard.md

@@ -0,0 +1 @@
+django-data-wizard.wq.io

docs/CNAME

@@ -0,0 +1,7 @@
+permalink: "/:title:"
+defaults:
+  - 
+    scope:
+       path: ""
+    values:
+       layout: "default"

docs/_config.yml

@@ -0,0 +1,59 @@
+<!doctype html>
+<html>
+  <head>
+    <title>{{ page.title }}{% if page.title != 'Django Data Wizard' %} - Django Data Wizard{% endif %}</title>
+    <script type="module" src="/js/$index.js"></script>
+    <meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1,minimum-scale=1,user-scalable=yes" />
+    <link rel="icon" type="image/svg+xml" sizes="any" href="/images/icons/django-data-wizard.svg">
+    <link rel="alternate icon" sizes="16x16 32x32 48x48" href="/favicon.ico">
+    <style>
+      img[src$=".svg"] {
+        display: block;
+        margin-left: auto;
+        margin-right: auto;
+        max-width: 100%;
+      }
+    </style>
+    <script async src="https://www.googletagmanager.com/gtag/js?id=G-9WXC2SBSHH"></script>
+    <script>
+      window.dataLayer = window.dataLayer || [];
+      function gtag(){dataLayer.push(arguments);}
+      gtag('js', new Date());
+      gtag('config', 'G-9WXC2SBSHH');
+    </script>
+  </head>
+  <body>
+    <div id="content" style="display:none">
+      {% if page.url != '/' %}
+      <nav>
+        <a href="/">Home</a>
+        &gt;
+        {% if page.dir != page.url %}
+        <a href="{{ page.dir }}">
+          {{ site.pages | where_exp:"p","p.url == page.dir" | map: "title" | first }}
+        </a>
+        &gt;
+        {% endif %}
+        {{ page.title }}
+      </nav>
+      {% endif %}
+      <main>
+        {{ content }}
+        {% if page.url == '/' %}
+        <ul>
+          {% for p in site.pages %}{% if p.wq_config != nil and p.wq_config.show_in_index != false %}
+          <li><a href="{{ p.url }}">{{ p.title }}</a></li>{% endif %}{% endfor %}
+        </ul>
+        {% elsif page.dir == page.url and page.wq_config.autoindex != false %}
+        <ul>
+          {% for p in site.pages %}{% if p.dir == page.dir and p.url != page.dir and p.name != '$index.json' %}
+          <li><a href="{{ p.url }}">{{ p.title }}</a></li>{% endif %}{% endfor %}
+        </ul>
+        {% endif %}
+      </main>
+    </div>
+    <script nomodule>
+      document.getElementById('content').style.display = 'block';
+    </script>
+  </body>
+</html>

docs/_layouts/default.html

@@ -0,0 +1,8 @@
+---
+layout: null
+---
+{{ site.pages
+   | where_exp:"p","p.dir == page.dir"
+   | where_exp:"p","p.name != page.name"
+   | where_exp:"p","p.name != 'index.md'"
+   | jsonify }}