You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+35-1Lines changed: 35 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,11 +43,32 @@ See <https://github.com/wq/django-data-wizard> to report any issues.
43
43
44
44
## Initial Configuration
45
45
46
+
Within a new or existing Django or wq project, configure the following:
47
+
48
+
1. Celery / Redis
49
+
2. A model for (up)loading source data
50
+
3. One or more serializers for populating the destination models
51
+
4. wq/progress.js plugin (if using wq)
52
+
46
53
### Celery
47
54
48
-
Django Data Wizard requires [Celery] to handle asynchronous tasks, and is usually used with [Redis] as the memory store. These should be configured first or the REST API may not work. Once Redis is installed, you should be able to add the following to your project settings:
55
+
Django Data Wizard requires [Celery] to handle asynchronous tasks, and is usually used with [Redis] as the memory store. These should be configured first or the REST API may not work. On Ubuntu, run the following command:
56
+
57
+
```bash
58
+
# Install redis on Ubuntu
59
+
sudo apt-get install redis-server
60
+
```
61
+
62
+
Once Redis is installed, you should be able to add the following to your project settings:
At least one serializer should be registered in order to use the wizard. Note the use of a human-friendly serializer label when registering. This name should be unique throughout the project, but can be changed later on without breaking existing data. (The class path is used as the actual identifier behind the scenes.)
174
195
196
+
### Progress Bar Support
197
+
198
+
If you are using the built-in Data Wizard interface for wq, be sure to enable the [wq/progress.js] plugin.
199
+
200
+
```javascript
201
+
// myapp/main.js
202
+
define(['wq/app', 'wq/progress', ...],
203
+
function(app, progress, ...) {
204
+
app.use(progress);
205
+
app.init(config).then(...);
206
+
});
207
+
```
208
+
175
209
## Run-Time Usage (REST API)
176
210
177
211
The Data Wizard REST API provides the following capabilities. If you are using wq.db, the wizard will automatically register itself with the router. Otherwise, be sure to include `data_wizard.urls` in your URL configuration:
0 commit comments