How fboerman/jao-py works
Project type and purpose
• This is an open-source Python client library (“jao-py”) for consuming various endpoints offered by JAO (Joint Allocation Office). It provides pandas-based wrappers around REST and SOAP APIs, plus CSV/XML download utilities, all packaged for easy pip installation.
File structure
• Top-level:
• .github/workflows: CI pipelines for tests and publishing to Test PyPI
• setup.py, setup.cfg, requirements.txt, manifest.in: packaging and distribution
• test_core_flowbased.py: a smoke/integration test for one of the legacy clients
• Main code under the jao/ package:
• jao/jao.py, jao/webservice.py: core HTTP client and request orchestration
• jao/parsers.py, jao/util.py, jao/exceptions.py: shared parsing, utilities, and error types
• jao/jao_intraday.py, jao/jao_nordic.py, jao/jao_parrun.py: “PublicationTool” clients for different JAO tools
• Subpackage jao/CWE/ (deprecated legacy clients):
• ASMX SOAP client, CSV downloader, XML downloader + their parsers and exception types
README for additional insights
• Four main modern clients:
a) JaoAPIClient (REST webservice)
b) JaoPublicationToolClient (core day-ahead)
c) JaoPublicationToolPandasIntraDay (intraday versions a/b/c)
d) JaoPublicationToolPandasNordics (nordic day-ahead)
• One “ParRun” client wrapping intraday for parallel run
• Deprecated “CWE” clients using suds-community and lxml/pillow for SOAP and file parsing
Detail without over-splitting
• Logical module but group closely related files
• Do not show every single source file; focus on package/subpackage level and key classes