New Feature: Async Client

[CHRISCARLON]

I often write a lot of custom async code to interact with the OS Datahub APIs.

A few projects are on my todo list in the future where I'll need async functionality (both personal and at work at GeoPlace).

Rather than write my own async library, I thought that I would start a rough async implementation of the osdatahub NGD module - as I have colleagues that use this too.

I do have some ideas for the other modules as well though - like downloading things from the DownloadsAPI in parallel.

Please let me know what you think!

I've not strayed too far from the current ngd_api in terms of the overall structure - let me know if you think I have.

I've added:

• A generic AsyncAPI client + rate limiter
• An async implementation of the NGD module
• Suggested a new FeatureCollection return type in models.py for the NGD module
• Slightly tweaked the _merge_all_geojsons function in the async implementation as I wasn't too sure about calling .copy() each time.

I'll mark this ready for review once I've added a few more unit tests and done some trial runs with it - as it's a first pass for now.

TODO:

• Add more unit tests
• Conduct trial runs locally
• Add in calls to osdatahub.get_proxies() (I store the proxies once on client creation instead of calling get_proxies() for every request).

Chris

[mhill-os]

✅ Snyk checks have passed. No issues have been found so far.

Status	Scanner	Critical	High	Medium	Low	Total (0)
✅	Open Source Security	0	0	0	0	0 issues
✅	Licenses	0	0	0	0	0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

[mhill-os]

✅ Snyk checks have passed. No issues have been found so far.

Status	Scanner	Critical	High	Medium	Low	Total (0)
✅	Open Source Security	0	0	0	0	0 issues
✅	Licenses	0	0	0	0	0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

[jmbraybrook]

Hi @CHRISCARLON ,

Just passing my thanks for contributing this and to acknowledge I've seen this.
Will take a look over the coming days and if all is well aim to get this feature incorporated.

Kind Regards
Joseph

[CHRISCARLON]

Hi @CHRISCARLON ,

Just passing my thanks for contributing this and to acknowledge I've seen this. Will take a look over the coming days and if all is well aim to get this feature incorporated.

Kind Regards Joseph

Hi @jmbraybrook,

No worries!

I added a couple of dependencies to the requirements.txt file as that seemed to be why the tests were failing in the action: https://github.com/OrdnanceSurvey/osdatahub/actions/runs/20646710797

Chris

[jmbraybrook]

Hi @CHRISCARLON , can confirm we will be including this feature - will be merging onto its own branch so I can run the required tests and checks but should be good to proceed from there. Will CC you into a subsequent pull request once that's done.