urbanpy icon indicating copy to clipboard operation
urbanpy copied to clipboard

Backwards compatibility of `download` module functions

Open paulavidela opened this issue 2 years ago • 3 comments

Hi! I have noticed that 'download' functions have been changed. However when I install urbanpy via pip install urbanpy in a Google Colab, I still have the function hdx_fb_population() available, and I can not use the new functions: get_hdx_dataset() or search_hdx_dataset(). This is not really an issue, but I am opening it because I would really appreciate to be notified when the package version is updated. Thanks!

paulavidela avatar Jun 17 '22 15:06 paulavidela

Hi Paula! Indeed, we are making changes to the download API in the upcoming version. Locally, you can use them by cloning the repo and running:

python3 setup.py install

within the UrbanPy repo. We are streamlining the development such that a stable 1.0.0 version can be released ASAP, we'll update this issue once the 1.0 version comes out @Claudio9701

a-regal avatar Jun 17 '22 18:06 a-regal

Thanks for the issue @paulavidela!

As @a-regal said we are working on the new release with mainly enhanced functions output ✨ and a more dev-friendly 🙌🏽 input parameter making custom overpass queries

Although we are still wondering If we should keep the hdx_fb_population and hdx_dataset functions with a deprecation warning or drop them from the download module. We are open to hearing comments on that 🤗

Claudio9701 avatar Jun 17 '22 20:06 Claudio9701

Hi @Claudio9701 and @a-regal ! I was able to install urbanpy locally and run Demo.ipynb (including the progress bar from my previous issue ), thanks!

I have only one comment about local installation: when I executed python3 setup.py install I got the following error:

Best match: hdx-python-api 5.7.2
Processing hdx-python-api-5.7.2.tar.gz
error: Couldn't find a setup script in /tmp/easy_install-ysipk2nk/hdx-python-api-5.7.2.tar.gz

So I installed that package using pip : pip install hdx-python-api==5.7.2 And then I rerun :python3 setup.py install

The second time, the installation process run perfectly.

Regarding the functions, even though hdx_fb_population is easier to run than get_hdx_dataset (because you only need to pass the name of the country), it is not working properly for some countries such as Chile or Ecuador. I would not mind to keep itwith a deprecation warning. Maybe you could also add a suggestion to use the other function for 'more available datasets'?

As for hdx_dataset, I think it is very useful if you already know which particular dataset you want from HDX.

Looking forward to the new version!

paulavidela avatar Jun 17 '22 22:06 paulavidela