AllenNeuralDynamics / AllenNeuralDynamics/ficus

Remove db-structure-related contents of settings.json

Open
#38 0 comments 0 reactions 1 assignee Claimed by @jessy-liao View on GitHub
Dominant language
Python
Stars
1
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Ficus **settings.json** file, currently required for each PC that wants to communicate with ficus, require a `scope` field.

Here's an [example settings.json](https://github.com/AllenNeuralDynamics/prototome-instrument/blob/dev/examples/ficus_setup.json).

The contents of the `scope` field are basically validating the internal structure of the connected database. If that's indeed the case, let's not do this at this level and instead do it inside of the ficus client library (probably with a pydantic model). Doing it at this level violates separation of concerns where each computer that wants to interact with the database needs to know something about its structure in order to interact with it rather than delegating that work to the ficus client library. It also makes the file harder to maintain since individual fields will need to change everywhere if the folder structure ever changes.

That's all to say, let's remove this `scope` field from **settings.json** if possible.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.