Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release managment #19

Open
ofuhrer opened this issue Nov 12, 2019 · 0 comments
Open

Release managment #19

ofuhrer opened this issue Nov 12, 2019 · 0 comments

Comments

@ofuhrer
Copy link
Contributor

ofuhrer commented Nov 12, 2019

Here are some thoughts now that fv3config is public...

  • Have you thought about release management, now that the repo is public?
  • Is now the right time to do a first release tag?
  • The documentation talks about a "stable" release using pip install. What is installed when somebody does pip install (releaseX.X?) and what is installed when somebody installs from source (master?)?
mcgibbon pushed a commit that referenced this issue Nov 19, 2019
Fixes #7. This PR changes the API in three ways:

- if environment variable `FV3CONFIG_CACHE_DIR` is set, fv3config will use this location for cache when imported (specifically a `fv3config-cache` subdirectory). Will use the user's cache directory if unset (changed from last version where we used the user's application data directory).
- new `fv3config.set_cache_dir(dirname)` can be used to change the cache dir after import
- new `fv3config.get_cache_dir()` will return the current cache directory
- Updated the installation documentation with warnings about this being pre-alpha, helps with #19

Some internal changes that don't affect API:

- data downloading is now tested, using temporary directories and by mocking requests.get
- some global variables have been reformatted to allcaps
- only one global variable in _datastore contains the cache directory, the other ones have been moved to private helper functions that will determine their values based on the current cache directory
- the options dictionaries now map to paths that are relative to the cache directory, and not including that directory

Small bug fix I bundled in this PR:
- fixed the `extras_require` keyword in setup.py, which was being ignored due to a typo

Commit history:

* refactor code to use one global variable for cache location

* implemented routines to set cache location

* moved data folder to testdata

* update testdata dirname in test

* fixed forcingdata tests to use temporary data directory

* fix path resolution for options to use dynamic cache dir

* Add testdata to manifest

* use fv3config-cache subdirectory, and user's cache folder

* remove comma

* added warnings about deleting data, ask for confirmation"

* use internal refresh function in test
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant