Skip to main content

Python module to get sunrise, sunset, daytime, and twilight data for a location.

Project description

Heliacal PyPI

Python module to get sunrise, sunset, daytime, and twilight data for a location.

This is an API wrapper for 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 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:

cd /Applications/Python\ 3.7
./Install Certificates.command

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Heliacal-2.0.1.tar.gz (2.0 kB view details)

Uploaded Source

File details

Details for the file Heliacal-2.0.1.tar.gz.

File metadata

  • Download URL: Heliacal-2.0.1.tar.gz
  • Upload date:
  • Size: 2.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2

File hashes

Hashes for Heliacal-2.0.1.tar.gz
Algorithm Hash digest
SHA256 45eac3344be5aedccacdf38203484461c972a0c9723e6cb5979e5d25cc4f7965
MD5 6780feb72d66c6b1c523e447f7e2467a
BLAKE2b-256 732c85ce84be764716ad31f3e377a0af03d72575ef88ffe4edea2e3913cd5ca4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page