Proposal todo list

[r0mainK]

Spitballing some ideas, @vmarkovtsev WDYT :

• [ ] Structure
  • [ ] Model stuff could be in a directory
  • [ ] Bakend stuff could be in a directory
  • [ ] Logging could be in a directory
  • [ ] Command line should be in a directory, and split properly (eg tools.py, registry.py)
  • [ ] All the rest should be in utils
• [ ] Command line
  • [ ] Add command to create configuration (modelforgecfg.py file or edit a given pre-existing bash/text file
  • [ ] Add command to edit only the registry (amend), by uploading a modified meta.json. It should be able to edit either a specific model, or a series of model
  • [ ] Add command to add external files to the registry, e.g. tests, travis.yaml file, etc
  • [ ] Include gitbooks, update templates
• [ ] Code
  • [ ] Switch to Pathlib entirely
  • [ ] Update the code, we are not even using the new functionnalities of slogging
  • [ ] Simplify the code as much as possible. For instance, Model().load( ... ) is overly complex, and some features are useless imo, eg loading a model from the model
• [ ] Documentation
  • [ ] Explain configuration, depending on the utilization. Right now it's quite opaque
  • [ ] Explain how metadata can be added in command line, there's no real explanaton apart from the default template and a link to src-d/models
  • [ ] We should talk about slogging since we use it, and it's part of the API
  • [ ] Add doc for new commands
  • [ ] Add an index of the API
  • [ ] List internal methods that should not be overrided in Model