diff --git a/README.md b/README.md index 40d94cd..0bd5165 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,69 @@ -# CDLDownloader +

CDL Downloader

+

Automation script for downloading medical test results files from ewyniki.cdl.pl

+ +

CDL Downloader makes use of Selenium test software to automatically fill patient data textboxes and download PDF files.

+ +--- + +## Features + +- Headless mode - can be used entirely without graphical interface +- Returns basic information after download - script returns basic data in JSON format, such as failure/success status and tests results as html table + +## Requirements + +- Chrome Driver installed +- PIP packages: + - `selenium` + - `webdriver-manager` + - `argparse` + +You can also use `requirements.txt` file to install PIP dependencies + +``` +pip install -r cdl_downloader/requirements.txt +``` + +## Usage + +``` +python cdl_downloader +``` + +**Additional options:** + +- `--headless` - headless mode +- `--path ` - set download path + +**Execution:** + +1. Script starts browser +2. Goes to ewyniki.cdl.pl barcode login page +3. Fills PESEL and barcode textbox and submit +4. Waits either for error message (and then stops and returns error) or download button +5. Gathers info about test results +6. Creates dedicated download directory +7. Downloads file + +**Returned data:** + +In case of failure: + +``` +{ + "success": false +} +``` + +In case of success: + +``` +{ + "success": true, + "id": "e1ce9235-9c36-4b7a-b245-e2f1c3d3b1c0", + "fileName": "/mnt/example/download_dir/e1ce9235-9c36-4b7a-b245-e2f1c3d3b1c0/TEST_FILE.pdf", + "formattedDate": "2026.01.31", + "resultTableHTML": "...
" +} +``` \ No newline at end of file