Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lonewanderer27/pcsolotto_webscraper
Python program for webscraping lottery results from the PCSO Website
https://github.com/lonewanderer27/pcsolotto_webscraper
lotto lotto-data python webscraper
Last synced: 18 days ago
JSON representation
Python program for webscraping lottery results from the PCSO Website
- Host: GitHub
- URL: https://github.com/lonewanderer27/pcsolotto_webscraper
- Owner: lonewanderer27
- License: apache-2.0
- Created: 2022-08-13T12:47:35.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-11-15T10:54:57.000Z (about 2 years ago)
- Last Synced: 2024-11-14T05:25:41.574Z (about 1 month ago)
- Topics: lotto, lotto-data, python, webscraper
- Language: Python
- Homepage:
- Size: 43.9 KB
- Stars: 2
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# PCSOLotto
PCSOLotto (Webscraper) is a Python program for webscraping lottery results from the [PCSO website](https://www.pcso.gov.ph/SearchLottoResult.aspx)
Can be be both used in CLI and embedded in a python program.
## Installation
Use pip to install to your local machine.
```bash
pip install PCSOLotto-Webscraper
```
Or if you want the latest version, use git on your local machine to clone this repository:
```bash
git clone https://github.com/lonewanderer27/PCSOLotto_Webscraper
```
Then you can copy `./src/PCSLotto/PCSOLotto.py` file to your python project where you wanna use it with.
# CLI
Results are displayed in a tabular form.
## Simple Usage Examples
```bash
# display results today
# only works after 10PM or when PCSO has posted the results on the website.
./PCSOLotto.py -t
# display results yesterday
./PCSOLotto.py -y
# display results 3 days prior up to today
./PCSOLotto.py -z
# display results 3 days prior up to today AND export it to CSV file
./PCSOLotto.py -z -c lotto_results.csv
```
Note: Using -t --results_today, -y --results_yesterday, -z --results_default_pcso overrides the -s --start_date and -e --end_date
Tip: You can export the search results to CSV and or JSON.
For CSV, just append the -c --csv .csv
For JSON, append the -j --json .json
## Advanced Usage Examples
```bash
# display EZ2 results yesterday
./PCSOLotto.py -y --games 'EZ2'
# display EZ2, Suertres & 6Digit results yesterday
./PCSOLotto.py -y --games 'EZ2' 'Suertres' '6Digit'
# display Suertres 11AM Draw result yesterday
./PCSOLotto.py -y --games 'Suertres Lotto 11AM'
# display 6/55 & 6/49 results yesterday
./PCSOLotto.py -y --games '6/55' '6/49'
```
By default, jackpot prices are prefixed with ₱ sign, you can disable that by adding `--peso_sign false` argument
```bash
# display 6/55 & 6/49 results yesterday
# but with ₱ sign omitted
./PCSOLotto.py -y --games '6/55' '6/49' --peso_sign false
```
## More Advanced Usage Examples
Use -s --start_date to define the start date and -e --end_date to define the end date
These arguments cannot be used together with -t --results_today, -y --results_yesterday, -z --results_default_pcso
```bash
# display results from Aug 1 2022 to Aug 10 2022
# Note: the only accepted date format is YYYY/MM/DD
./PCSOLotto.py --start_date '2022/08/01' --end_date '2022/08/10'
# you can also export to CSV and JSON
./PCSOLotto.py --start_date '2022/08/01' --end_date '2022/08/10' -c results_csv.csv -j results_json.json
# display 6/58 results from Aug 1 2022 to Aug 10 2022
./PCSOLotto.py --start_date '2022/08/01' --end_date '2022/08/10' --games '6/58'
# display 6/58, 6/55 & 6/42 results
# from Aug 1 2022 to Aug 10 2022
./PCSOLotto.py --start_date '2022/08/01' --end_date '2022/08/10' --games '6/58' '6/55' '6/42'
# display results every Mon, Wed, Fri
# from Aug 1 2022 to Aug 10 2022
./PCSOLotto.py --start_date '2022/08/01' --end_date '2022/08/10' --days Mon Wed Fri
# display only EZ2 results every Mon, Wed, Fri
# from Aug 1 2022 to Aug 10 2022
./PCSOLotto.py --start_date '2022/08/01' --end_date '2022/08/10' --days Mon Wed Fri --games 'EZ2'
```
See [Table-of-Games](#Table-of-Games) for complete list of game aliases and how to filter time specific draws for EZ2 & Suertres.
## CLI Options Reference
```bash
usage: PCSOLotto.py [-h] [-s START_DATE] [-e END_DATE] [-t] [-y] [-z] [-d [DAYS ...]] [-g [GAMES ...]] [-p PESO_SIGN] [-c CSV] [-j JSON]
CLI tool for web scraping lottery results from the PCSO website
options:
-h, --help show this help message and exit
-s START_DATE, --start_date START_DATE
date to start searching. Format: YYYY/MM/DD (default: None)
-e END_DATE, --end_date END_DATE
date to end searching. Format: YYYY/MM/DD (default: None)
-t, --results_today retrieve lotto results today (default: False)
-y, --results_yesterday
retrieve lotto results yesterday (default: False)
-z, --results_default_pcso
retrieve lotto results from 3 days prior up to today (default: False)
-d [DAYS ...], --days [DAYS ...]
days to select (default: None)
-g [GAMES ...], --games [GAMES ...]
lotto games to search (default: None)
-p PESO_SIGN, --peso_sign PESO_SIGN
to prefix a peso sign in the jackpot, or not (default: True)
-c CSV, --csv CSV csv file to output the results to (default: None)
-j JSON, --json JSON json file to output the results to (default: None)
```
# API / Library
All methods return a dictionary, organized by keys under which the actual results are contained in.
## Simple Usage Examples
```python
from PCSOLotto import PCSOLotto
from pprint import pprint # for pretty printing of returned dictionary
# initiate an object from the class
lotto = PCSOLotto()
# return results today
# only works 10PM onwards as that is when PCSO updates their website
pprint(lotto.results_today(), indent=2)
# return results yesterday
pprint(lotto.results_yesterday(), indent=2)
# return results for the past 3 days
# default selection on the PCSO website
pprint(lotto.results_latest(), indent=2)
```
## Advanced Usage Examples
Methods `results_today()`, `results_yesterday()` and `results_latest()` all have an optional `games` parameter where you can customize what lottery games get returned.
To match a specific game, we have to use an alias or the whole name of the lottery game. Refer to [Table-of-Games](#Table-of-Games) for these aliases.
```python
from PCSOLotto import PCSOLotto
from pprint import pprint # for pretty printing of returned dictionary
# initiate an object from the class
lotto = PCSOLotto()
# return EZ2 results yesterday
pprint(
lotto.results_yesterday(
games=['EZ2']),
indent=2)
# return EZ2, Suertres & 6Digit results yesterday
pprint(
lotto.results_yesterday(
games=['EZ2', 'Suertres', '6Digit']),
indent=2)
# return 6/55 & 6/49 results yesterday
pprint(
lotto.results_yesterday(
games=['6/55', '6/49']),
indent=2)
```
And by default all of three methods we used prefix the jackpot price with ₱ sign, you can disable that by passing `peso_sign=False` parameter.
```python
# return 6/55 & 6/49 results yesterday
# but with ₱ sign omitted
pprint(
lotto.results_yesterday(
games=['6/55', '6/49'],
peso_sign=False),
indent=2)
```
## More Advanced Usage Examples
Methods described in Simple & Advanced Usage all use a method underneath called `results()` which takes five parameters that are described in the [API-Reference](#API-Reference)
You can use this method directly if you want to customize the results date.
```python
from PCSOLotto import PCSOLotto
from pprint import pprint # for pretty printing of returned dictionary
# initiate an object from the class
lotto = PCSOLotto()
# Search for results from Aug 1 2022 to Aug 10 2022
# Note: the only accepted date format is YYYY/MM/DD
pprint(
lotto.results(
start_date='2022/08/01',
end_date='2022/08/10'),
indent=2
)
# Search for 6/58 results from Aug 1 2022 to Aug 10 2022
pprint(
lotto.results(
start_date='2022/08/01',
end_date='2022/08/10',
games=['6/58']),
indent=2
)
# Search for 6/58, 6/55 & 6/42 results
# from Aug 1 2022 to Aug 10 2022
pprint(
lotto.results(
start_date='2022/08/01',
end_date='2022/08/10',
games=['6/58', '6/55', '6/42']),
indent=2
)
# Search for results every Mon, Wed, Fri
# from Aug 1 2022 to Aug 10 2022
pprint(
lotto.results(
start_date='2022/08/01',
end_date='2022/08/10',
days=['Mon', 'Wed', 'Fri']),
indent=2
)
```
# API-Reference
| Parameter | Type | Format | Description |
| :-------- | :------- | :------------|:------------------------- |
| `start_date` | `string` | YYYY/MM/DD |**Required**. date to start searching |
| `end_date` | `string` | YYYY/MM/DD |**Required**. date to end searching |
| `days` | `list(string)` | ['Sun', 'Mon'] ... | **Optional**. days to select |
| `games` | `list(string)` | ['EZ2', 'Suetres'] ... | **Optional**. games to select |
| `peso_sign` | `bool` | `True` or `False` | **Optional**. to prefix a peso sign in the jackpot, or not |
# Table-of-Games
Tip:
Using "3D" alone will match all draws that happen in 11AM, 4PM & 9PM
So if you only want the 4PM draw, use "3D Lotto 4PM" instead.
Additionally, PCSO changes the name of the games on their website, causing this program to fail.
So if this program does not return any data, please [visit](https://www.pcso.gov.ph/SearchLottoResult.aspx) and look for the "Lotto Game" column to see the new games name, then try again.
| Alias | Game Full Name |
|--------------------- |--------------------- |
| 6/58 | Ultra Lotto 6/58 |
| 6/55 | Grand Lotto 6/55 |
| 6/49 | Superlotto 6/49 |
| 6/45 | Megalotto 6/45 |
| 6/42 | Lotto 6/42 |
| 6D | 6D Lotto |
| 4D | 4D Lotto |
| 3D | 3D Lotto |
| 3D Lotto 11AM | 3D Lotto 11AM |
| 3D Lotto 4PM | 3D Lotto 4PM |
| 3D Lotto 9PM | 3D Lotto 9PM |
| 2D | 2D Lotto |
| 2D Lotto 11AM | EZ2 Lotto 11AM |
| 2D Lotto 4PM | EZ2 Lotto 4PM |
| 2D Lotto 9PM | EZ2 Lotto 9PM |