opendataservices / fireproofbox-standard

fireproofbox-standard

The standard for keeping track of things in the fireproof box.

With Docker

docker build -t ods/fireproofbox .
docker run -ti -v /path/to/fireproofbox-standard/:/app ods/fireproofbox

Build docs

To build the Sphinx docs in the Docker container:

cd docs/
make html

Static files are in _build directory.

With Vagrant

vagrant up
vagrant ssh
build-sphinx

Then browse to http://localhost:8080/

When in the vagrant shell, jsonschema and flatten-tool are also available. You will find your working files in /vagrant.

To exit:

exit
vagrant halt

fireproofbox-standard's Issues

Should we have some way of saying if the thing is about certain staff members?

A new field or something?

eg This is Fred's passport photocopy

Use case is "Fred has left, list all the documents about Fred".

Date is currently a free text string - can we add stricter validation?

Should we have some way of tracking when things can be destroyed?

eg "Fred has left, in 3 years time we can destroy his right to work checks. Mark that we can destroy these documents after this date." (I'm not sure if it is 3 years, just an example)

Or maybe the other way round, if something has to be kept maybe track the reasons it should be kept?

Can't get flatten-tool to make an csv of example1.csv

vagrant@ubuntu-xenial:/vagrant$ flatten-tool flatten  -f csv -o standard/example1.csv   standard/example1.json 
Traceback (most recent call last):
  File "/usr/local/bin/flatten-tool", line 6, in <module>
    exec(compile(open(__file__).read(), __file__, 'exec'))
  File "/vagrant/src/flattentool/flatten-tool", line 3, in <module>
    flattentool.cli.main()
  File "/vagrant/src/flattentool/flattentool/cli.py", line 212, in main
    flatten(**kwargs_from_parsed_args(args))
  File "/vagrant/src/flattentool/flattentool/__init__.py", line 69, in flatten
    parser.parse()
  File "/vagrant/src/flattentool/flattentool/json_input.py", line 98, in parse
    root_json_list = path_search(self.root_json_dict, self.root_list_path.split('/'))
  File "/vagrant/src/flattentool/flattentool/input.py", line 794, in path_search
    nested_dict[parent_field] = OrderedDict()
TypeError: list indices must be integers or slices, not str

It seems to not like the list being the root element.

If we change the sample so it's in a key called "main"

{"main":[
  {
    "id": "id1",
    "title": "Passport Check for James",
    "date_added": "2018-02-13"
  },
  {
    "id": "id2",
    "title": "Insurance certificate",
    "date_added": "2016-01-13"
  }
]
}

It flattens fine.

Currently reading docs to work out .....

Should we have some way of saying what type of thing it is?

Also discussed was that it might not be documents - the electronic security bank fob was mentioned as a non-paper thing that might go in.

eg "paper", "key fob"

Or maybe go further and say what is on document?

eg "Passport photocopy", "Visa photocopy"