https://github.com/reedhaffner/heliacal
Python module to get sunrise, sunset, daytime, and twilight data for a location.
https://github.com/reedhaffner/heliacal
api-wrapper python sunrise sunset twilight-data
Last synced: 6 months ago
JSON representation
Python module to get sunrise, sunset, daytime, and twilight data for a location.
- Host: GitHub
- URL: https://github.com/reedhaffner/heliacal
- Owner: reedhaffner
- License: gpl-3.0
- Created: 2018-12-30T02:12:17.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-03-12T00:52:08.000Z (over 7 years ago)
- Last Synced: 2025-08-30T16:41:37.304Z (10 months ago)
- Topics: api-wrapper, python, sunrise, sunset, twilight-data
- Language: Python
- Size: 21.5 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Heliacal [](https://pypi.org/project/Heliacal/)
Python module to get sunrise, sunset, daytime, and twilight data for a location.
This is an API wrapper for [sunrise-sunset.org](https://sunrise-sunset.org/).
## To get started, install heliacal
pip install heliacal
## Next, add heliacal and datetime to your project
from heliacal import Heliacal
import datetime
Heliacal requires datetime to run.
## Create a heliacal object
Heliacal uses latitude and longitude to determine solar data for a location. You can use modules such as [geopy](https://geopy.readthedocs.io/en/stable/) to get the co-ordinates of a named location.
los_angeles = Heliacal(34.052235, -118.243683)
By default, Heliacal will set the date to today, to change that, use set_date().
los_angeles.set_date(datetime.datetime(2018, 12, 31)) # Get solar data for 2018-12-31
You now have a working Heliacal instance! You can get the following information:
los_angeles.sunrise # 2018-12-31 14:58:24
los_angeles.sunset # 2019-01-01 00:54:16
los_angeles.solar_noon # 2018-12-31 19:56:20
los_angeles.day_length # 35752 (seconds)
los_angeles.civil_twilight_begin # 2018-12-31 14:30:50
los_angeles.civil_twilight_end # 2019-01-01 01:21:49
los_angeles.nautical_twilight_begin # 2018-12-31 13:59:38
los_angeles.nautical_twilight_end # 2019-01-01 01:53:01
los_angeles.astronomical_twilight_begin # 2018-12-31 13:29:11
los_angeles.astronomical_twilight_end # 2019-01-01 02:23:28
# For debugging or other things, there are:
los_angeles.requesturl # https://api.sunrise-suns...
los_angeles.json # {'sunrise': '2018-12-31T14:58:...
Note: Heliacal returns UTC datetimes, it is the developer's job to turn them to the respective timezone.
## Troubleshooting
If you receive an `SSL: CERTIFICATE_VERIFY_FAILED` error and you are using MacOS. Follow these steps in terminal:
```sh
cd /Applications/Python\ 3.7
./Install Certificates.command
```