schema-automator icon indicating copy to clipboard operation
schema-automator copied to clipboard

todo (before merging webmap code into main ?)

Open turbomam opened this issue 4 years ago • 3 comments

@cmungall

  • [x] remove all research-project specific files
  • [ ] remove mentions of research-project specific files from READMEs
  • [ ] move research-project specific files to their own repos
    • they're currently in a local, .gitignored folder on @turbomam 's laptop
  • [ ] create tabular output in SSSOM format
    • [ ] confidence = 1 - cosine distance between query and matched term?

Makefile:

include a simpler example within this repo e.g

  • [ ] mixs
  • [x] a fake simple example

mapping code in general

  • [ ] minor: some of this belongs in git commit messages
  • [x] in general no need to retain commented out code, git takes care of history
  • [ ] in general most docs should go in docstrings so they are visible at IDE/RTD level
  • [ ] we may want to think about a yaml config file in the future
    • (the config file would be described using linkml)
  • [ ] consider using rtd to document this repo

@wdduncan

You may want to consider

  • [ ] creating a pypi package for this
  • [ ] attaching command-line utils to the package. I have examples of this in nmdc-schema.

turbomam avatar May 11 '21 14:05 turbomam

@wdduncan can you elaborate on what a CLI utility for the webmapping would look like? I am already using a click CLI.

turbomam avatar May 11 '21 14:05 turbomam

In the setup.py on nmdc-schema you will see the validate-nmdc-json and nmdc-version entry points.

This allows to run the associated python files from any directory just like other command line tools. E.g., after installing nmdc-schema (i.e., pip install nmdc-schema) you can find out the version of the schema by executing nmdc-version.

To accomplish the same thing with a .py file you need to 1) clone the repo and 2) modify your path to include the .py file.

wdduncan avatar May 12 '21 02:05 wdduncan

I am going to close for now; I think a lot of this functionality is in place. Please reopen if needed.

sierra-moxon avatar Mar 24 '23 21:03 sierra-moxon