For those who would like to contribute to the WxData Project, please take note of the following guidelines.
In order for your pull request to be accepted, you must comply with the following guidelines:
- Your addition must work on VPN/PROXY server connections and allow users to pass in their PROXY settings. The
requestspackage is recommended for this. - Your addition must have a scanner to prevent repetative downloads.
- Your addition shall only download PUBLICLY available data. Nothing that requires API Keys or Passwords will be accepted.
- Your addition must pre-process and post-process data.
- Do not plagerize anyone else's work.
- You are not allowed to use packages that are not available on BOTH Anaconda and PYPI (pip) (i.e. pygrib is not allowed and users must use xarray with cfgrib for post-processing)
- This project must be available on PYPI in addition to Anaconda to maximize access for use.
- The use of setup.py files is forbidden due to security vulerabilities associated with the use of setup.py. We use pyproject.toml for building our recipe.
- If you are adding data access for a new data source or using new packages not already used in WxData, please cite the data source/package at the following:
- Be willing to accept feedback and constructive criticism.
- Be respectful.
- Have fun!