Metadata-Version: 2.1
Name: Heliacal
Version: 2.0.1
Summary: Python module to get sunrise, sunset, daytime, and twilight data for a location.
Home-page: https://github.com/reedhaffner/heliacal
Author: Reed Haffner
Author-email: reedhaffner@pm.me
License: UNKNOWN
Description: # Heliacal [![PyPI](https://img.shields.io/pypi/v/Heliacal.svg)](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
        ```
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3
Description-Content-Type: text/markdown
