Open Web Calendar

You might want to:

Python: 3.7, 3.8, 3.9, 3.10

There are several commercial solutions which allow embedding of calendars into my website. I only have a link to an ICS file and want to show a nice-looking calendar on my site. Browser-only calendars usually have the problem that many ICS files can not be accessed (such as ownCloud/nextCloud in my case). I also want to be in control over who knows the people who visit the site and not pass everything to Google. This is a solution in my case which I share with the world. You are free to use it or deploy your own, modify or share it. It works offline and in company networks, too.

Features

Embedded calendar
Choice of time zone
ICS link, best multiple
month/week as a view
name, time of event, link?
showing the time span
styling of choice (icon, color, font, ...)

Contributing

There are several ways in which you can help this project:

Use it and report errors
Donate using Open Collective
Fund specific issues with Polar
Donate using GitHub Sponsors
Translate this project
Have a look at open issues e.g. those especially to get started, labelled good first issue, leave a note and work on it.

Translation

You can help us by translating the project to your language. If your language is not listed, please request to add it!

Translate on Weblate

Here, you can see the current translation status:

Deployment

There are several ways to deploy the open-web-calendar.

Environment Variables - Configuration

These environment variables can be used to configure the service:

APP_DEBUG default true, values true or false, always false in the Docker container
Set the debug flag for the app.
PORT default 5000, default 80 in the Docker container
The port that the service is running on.
WORKERS default 4 only for the Docker container
The number of parallel workers to handle requests.
CACHE_REQUESTED_URLS_FOR_SECONDS default 600
Seconds to cache the calendar files that get downloaded to reduce bandwidth and delay.

Docker

To build the container yourself type the command

docker build --tag niccokunzmann/open-web-calendar .

You can also use the existing image: niccokunzmann/open-web-calendar.

docker run -d --rm -p 5000:80 niccokunzmann/open-web-calendar

Then, you should see your service running at http://localhost:5000.

Container Tags

The container niccokunzmann/open-web-calendar:latest contains the latest release. Containers are also tagged with the version from the changelog, e.g. niccokunzmann/open-web-calendar:v1.10. If you wish to run the latest development version, use niccokunzmann/open-web-calendar:master.

Docker Compose

Using pre build dockerhub image with docker-compose

version: '3'
services:
  open-web-calendar:
    image: niccokunzmann/open-web-calendar
    ports:
      - '80:80'
    environment:
      - WORKERS=4
    restart: unless-stopped

To deploy the open-web-calendar with docker-compose, do the following steps:

Copy the docker-compose.yml file to the directory from where you want to run the container.
If needed change port mapping and environment variables.
Type docker-compose up -d to start the container.
The container will be pulled automatically from dockerhub and then starts.

Important Note: If you use this service, consider setting up log rotation as it is very talkative.

Update prebuild image with Docker Compose

If you want to update your image with the latest version from dockerhub type docker-compose pull

Note: You need to start the container after pulling again in order for the update to apply (docker-compose up -d)

Vercel

You can create a fork of this repository which automatically deploys to Vercel:

Deploy

Alternatively you can create a one off deploy by cloning this repository and running npx vercel at the root.

Heroku

You can deploy the app using Heroku.

Heroku uses gunicorn to run the server, see the Procfile.

Research

Hosts

https://www.chronoflocalendar.com/
with API: http://www.instantcal.com/api.html
Wordpress: https://de.wordpress.org/plugins/all-in-one-event-calendar/

Sources/Libs

https://stackoverflow.com/questions/9072802/is-there-an-open-source-javascript-calendar-that-supports-built-in-event-detail#9072985

Search Terms

calendar ics service, ics calendar to html, open source calendar view ical, python Ical, calendar viewer website for ics, open source calendar website, embed calendar into website

Software Components

Python3 and the packages in requirements.txt
- Flask
DHTMLX scheduler
python-recurring-ical-events

Development

Optional: Install virtualenv and Python3 and create a virtual environment.
```
virtualenv -p python3 ENV
source ENV/bin/activate
```
Install the packages.
```
pip install -r requirements.txt
```
Start the app.
```
python3 app.py
```

For the configuration of the app through environment variables, see the app.json file.

Running Tests

To run the tests, we use tox. tox tests all different Python versions which we want to be compatible to.

pip install tox

Run all tests:

tox

Run a specific Python version:

tox -e py39

Updating Dependencies

We use pip-compile to guarantee a tested deployment by fixing all the dependencies to a specific version.

You can update the packages to the latest version:

rm requirements.txt test-requirements.txt
pip install --upgrade pip-tools -r requirements.in -r test-requirements.in
pip-compile -o requirements.txt requirements.in
pip-compile -o test-requirements.txt test-requirements.in

And run the tests:

tox

Changelog

v1.16
- Add a dropdown to choose another time zone to view the calendar in the about screen, see Issue #213.
v1.15
- Update dependecies
v1.14
- Improve Indonesian translation by Reza Almanda
- Improve Spanish translation by zyloj
- Improve Polish translation by Eryk Michalak
- Update dependencies
- Do not test Python 3.7 any more
- Test Python 3.11
v1.13
- Improve French translation
- Update dependencies
v1.12
- Add Croatian UI by Milo Ivir
v1.11
- Add German UI
- Improve calendar in Polish
- Add Welsh calendar
v1.10
- Add translations for nb_NO.
- Translate the user interface.
- Use weblate to translate files.
v1.9
- Speed up loading with start and stop date range. Pull Request #177.
v1.8
- Add start of day, end of day and time step (hour be default) in Pull Request #158 thanks to @TheoLeCalvar.
v1.7
- Add timezone functionality. See Issue #171.
v1.6
- Add choice of Sunday or Monday for the start of the week Issue 39 - backed by donation!
v1.5
- add link to Contributing Section in about page
- make event clickable even if there is a tool tip window
- @MrKoga donated to the project! Thanks!
v1.4
- add event categories when you click an event, see PR 159.
v1.3
- update translation mistake
- fix encoding problem for languages other than en/de
- add ability to remove all controls
- test with GitHub actions
- test user interface
v1.2
- Use Gunicorn in Docker image
- change deployment to https://open-web-calendar.hosted.quelltext.eu/
v1.1
- Add Coatian Language by Tomislav Gomerčić
v1.0
- Create the changelog.
- Add support for colors from ICS calendars, see Issue #52 and Pull Request 88.

Update Dependencies

Enter your virtual environment. E.g.
```
source .tox/py39/bin/activate
```

Install all dependencies:

pip install -r requirements.in -r test-requirements.in pip-tools

Fix the dependencies:

rm *requirements.txt
pip-compile --output-file=requirements.txt requirements.in
pip-compile --output-file=test-requirements.txt test-requirements.in

Create a branch, commit:

git branch -d update
git checkout -b update
git add *requirements.txt
git commit -m"Update dependencies"
git push -u origin update

Create a Pull Request and see if the tests run.

Release a new Version

To release a new version:

Edit the README.md file in the Changelog Section and add the changes.

git add README.md
git commit -m"Modify changelog for release"
git push

Create a tag for the version.
```
git tag v1.6
git push origin v1.6
```
Notify solved issues about the release.

Related Work

docker-ics-view and its Docker image - a fork of this project with further improvements
calender_merger for merging several ICAL files into one
ical-filter for filtering events in an ICAL file and providing the selection as file
Wordpress all in one event calendar
My Mailbox Calendar

niccokunzmann/open-web-calendar

niccokunzmann

Reviews

Repository Details