Suncal creates a sun calendar. You can choose between the following events: sunrise, sunset, golden-hour-morning and golden-hour-evening - which should be of particular interest for photographers 📷. Parameters like geographic location (longitude & latitude), timezone and the range of dates for which these events should be created can be specified ad libitum. If you register this application in google cloud and grant read and write access to your personal google calendar, the events can be inserted directly into your google calendar using api calls. You specify the name of your target calendar and if it does not exist, it will be created for you.
Alternatively you can use this application to create an ics file and import it to any calendar you like. In that case, registration/authentication are unnecessary.
While the api functionality is only of interest for users of google calendar, the generated calendar ics file is universal (conforms to this standard) and so it can be imported to every calendar application.
The application was built with poetry and depends on python 3.7, so make sure you have poetry and any minor version of python 3.7 installed on your system (to manage several installations of python we recommend using pyenv).
Clone this repository, cd to the repository and run
poetry installThis will set up a virtual environment and install the application (including all dev and non-dev dependencies).
To allow insertion of events into your google calendar, the app has to be registered in google cloud and access to the api enabled. The google cloud console is also the place where you can create credentials (a file named "credentials.json"). When you run the application for the first time, the authentication flow will lead to the creation of access tokens (the credentials are required in this process!). All details of the process are outlined here.
Navigate into the project folder (top level) (credentials and access tokens must be stored in this directory as well), then run
poetry run suncal api --helpto see a description of all command line options. Example for a complete set of options:
poetry run suncal api --cal Sonne --from 2021-6-10 --to 2021-6-10 --event sunrise --timezone 'Europe/Berlin' \
--long 14.32 --lat 52or for Redwood City:
poetry run suncal api --cal Sonnenaufgang --from 2023-1-01 --to 2023-12-31 --event sunrise --timezone 'US/Pacific' \
--long -122.2281 --lat 37.4848If you want to export the sun calendar to an ics file, registration of this app in google cloud is unnecessary. You can provide a name for the ics file, but if you don't, the name will be created automatically. You can see a description of all command line options with:
poetry run suncal ics --helpExample:
poetry run suncal ics --from 2021-6-10 --to 2021-6-10 --event sunrise \
--long 14.32 --lat 52 --filename myIcsFile.icsThis repo uses type annotation. To add code, create a new branch and make sure to run all checks before setting up your PR: cd to the repo, then run:
./qa/pychecks.shIf any of the checks fail, the PR will not be accepted. If you add a function/class, you also add a corresponding test.
This package calculates various sun and moon parameters for specified locations and dates. It has an inbuilt database that contains longitude, latitude and timezones for the big cities in the world.
Tools for communication with google api and authentication flow.
Data validation and settings management using python type annotations. Pydantic enforces type hints at runtime. Ideal for exchanging data with APIs.
For a comprehensive list check the pyproject.toml.