Skip to content

Commit 2199ac0

Browse files
authored
more config tips [skip ci]
1 parent 6a36cbc commit 2199ac0

File tree

1 file changed

+35
-1
lines changed

1 file changed

+35
-1
lines changed

README.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,32 @@ See <https://github.com/wq/django-data-wizard> to report any issues.
4343

4444
## Initial Configuration
4545

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+
4653
### Celery
4754

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:
4963
```python
5064
# myproject/settings.py
65+
66+
INSTALLED_APPS = (
67+
# ...
68+
'data_wizard',
69+
'myapp',
70+
)
71+
5172
CELERY_RESULT_BACKEND = BROKER_URL = 'redis://localhost:6379/1'
5273
```
5374

@@ -172,6 +193,19 @@ registry.register("Time Series", TimeSeriesSerializer)
172193

173194
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.)
174195

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+
175209
## Run-Time Usage (REST API)
176210

177211
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

Comments
 (0)