Contribute#

Contributions are welcome: open an issue or a pull request on GitHub. Develop sets up the development environment.

People who use AI follow the AI policy of icalendar and the Python Calendaring Ecosystem. The prompts of AI agents are recorded with ai-prompt-auto-commit and added to the commit messages; make dev installs its hooks. todo.txt lists the requirements of the prompts and what is open.

Every change that people notice has a news fragment in news/, such as news/12.feature.rst, and updates the documentation.

Translate#

The site speaks English, German and Spanish. The language comes from the browser; the menu with the globe at the top keeps another choice in a cookie. The texts are in pycal_dashboard/locale/<language>/LC_MESSAGES/django.po.

Improve a translation#

  1. Change the msgstr of the text in django.po.

  2. Run make messages: it updates the texts of all languages and compiles them into django.mo. It uses gettext, or Docker if gettext is not installed.

  3. make test checks that every text of German and Spanish is translated, that none is marked fuzzy and that django.mo is compiled.

A changed English text makes make messages mark its translation #, fuzzy or add an empty msgstr: translate it and remove the mark.

Add a language#

  1. Add it to LANGUAGES in pycal_dashboard/settings.py and to MESSAGES in the Makefile, such as -l fr.

  2. Run make messages and translate pycal_dashboard/locale/fr/LC_MESSAGES/django.po.

Texts in the templates are in {% translate %} or {% blocktranslate %}; texts in Python in gettext. A text without them stays English, and a test finds it. The JSON of the pages, the log and the details of errors to copy stay English.

License#

dashboard.pycal.org is free software under the AGPL-3.0-or-later: you may use, study, share and change it; a changed version that you run for others must offer its source code. The project follows the REUSE specification: REUSE.toml says the copyright and license of every file, the texts are in LICENSES/. The icon of pycal is under CC-BY-SA-4.0, the mark of GitHub under MIT. make reuse checks it.

The page /licenses/ of the site lists these licenses and those of the Python packages that run on the server.