Isca icon indicating copy to clipboard operation
Isca copied to clipboard

Python interface refactoring

Open rosscastle opened this issue 4 years ago • 2 comments

Master issue for refactoring Isca's Python interface

Modern Python libraries and conventions

  • [ ] Support only Python 3.6+
  • [ ] Use pathlib for all path-like objects
  • [ ] Use subprocess or shutil instead of sh
  • [ ] Apply black formatting
  • [x] Move setup options to setup.cfg
  • [ ] Use f-strings
  • [ ] Fix docstrings

Tests

  • [ ] Add tests for the python API

Package clean-up

  • [x] Store templates and auxiliary data files in aux/
  • [ ] Check what scripts are obsolete and remove them
  • [ ] Move executable scripts to a separate folder
  • [ ] Merge various utility functions into specific submodules
  • [x] Create separate submodules for exceptions, paths, decorators
  • [ ] Clean up alert/email scripts
  • [ ] Move Makefile templates into a more appropriate location
  • [ ] Move the package source code to the root
  • [ ] Change GFDL_* env variables to ISCA_*

Docs

  • [ ] Link to sphinx config

rosscastle avatar May 06 '20 14:05 rosscastle

why was this closed @rosscastle ?

dennissergeev avatar Apr 06 '22 16:04 dennissergeev

Sorry Denis, it was an accident. I was closing the docs issues as we're done with that now and we were trying to tidy up the issues and PRs but I shouldn't have closed this one as it is more general.

rosscastle avatar Apr 06 '22 20:04 rosscastle