@@ -26,11 +26,11 @@ Once your Python code is ready, the next thing to do is to install a developemen
...
@@ -26,11 +26,11 @@ Once your Python code is ready, the next thing to do is to install a developemen
### Step 3: Add your database JSON and Views to beat.databases
### Step 3: Add your database JSON and Views to beat.databases
Inside `beat.web`, you'll find a checkout of `beat.databases` in `src/beat.databases`. Go ahead and create the view files and JSON descriptors matching the existing structure. JSON descriptors are inserted into `<beat.databases-root>/beat/databases/prefix/advanced/databases`. Views are inserted into `<beat.databases-root>/beat/databases/<database-name>`. Add your database satellite package to the `setup.py` of `beat.databases`.
Inside `beat.web`, you'll find a checkout of `beat.examples` in `src/beat.examples`. Go ahead and create the view and JSON descriptors matching the existing structure. Both JSON and the (python) View files should be uploaded to the BEAT server.
> Note: If your Bob satellite package for the database is **not** available on PyPI, you must also add a
> Note: If your Bob satellite package for the database is **not** available on PyPI, you must
> checkout/mr.developer line on `beat.web/buildout.cfg` so that the system can properly download and install it
> also add a checkout/mr.developer line on `beat.web/buildout.cfg` so that the system can
> from its repository.
> properly download and install it from its repository.
Re-run `./bin/buildout` at the `beat.web` level to make sure the new satellite package is installed and all is good for your first test.
Re-run `./bin/buildout` at the `beat.web` level to make sure the new satellite package is installed and all is good for your first test.
...
@@ -58,7 +58,7 @@ Once all is in place, you can quickly modify the views and algorithms so that th
...
@@ -58,7 +58,7 @@ Once all is in place, you can quickly modify the views and algorithms so that th
### Step 6: Commit to `beat.databases`
### Step 6: Commit to `beat.databases`
Once you are happy with all you did, you may commit the changes into the `beat.database` package. You should, *at least*, include the database JSON, a RestructuredText description and the Python views, but it is also recommended you include a baseline toolchain, experiment and algorithms so that others can test your setup during development.
Once you are happy with all you did, you may commit the changes into the `beat.examples` package. You should, *at least*, include the database JSON, a RestructuredText description and the Python view, but it is also recommended you include a baseline toolchain, experiment and algorithms so that others can test your setup during development.
> Note: If you have a database which is already in production at the BEAT platform, make sure that, when
> Note: If you have a database which is already in production at the BEAT platform, make sure
> you modify your database, you create a new version.
> that, when you modify your database, you create a new version.
