search

blaylockbk / SynopticPy

Retrieve mesonet weather data as Polars DataFrames from Synoptic's Weather API.
https://synopticpy.readthedocs.io/
MIT License
50 stars 6 forks source link

Unclear requirement for `../synoptic` directory #8

Closed dsjstc closed 2 years ago

dsjstc commented 2 years ago

Setup docs say to create ../synoptic/ and add a cfg file there, this appears obsolete. It works fine in the CWD though, and that's much more convenient for deployable scripts. Also, that means that the inelegant suggestion to sys.path.append('../') is no longer needed.

Also: it appears there's an undocumented dependency on toml.

blaylockbk commented 2 years ago

ah, yes, I do need to clean up the docs and README. Thanks for the prompt.

The more updated setup instructions are here https://blaylockbk.github.io/SynopticPy/_build/html/user_guide/setup.html The config file is created here: ~/.config/SynopticPy/config.toml

I'll add toml to the setup.py requirements.