diff --git a/README.md b/README.md index f054222..2796819 100644 --- a/README.md +++ b/README.md @@ -1 +1,45 @@ -# RaspAgenda \ No newline at end of file +# Installation + +There are some python libraries that are necesary for this project. I recommend creating a virtual enviroment to have all of those libraries isolated from your system packages. + +You can install them using the `requirements.txt` or just with `pip install `. +I've tested both methods and both works, in case any library is updated and gives any problem, the `requirements.txt` should still work. + +### `requirements.txt` method + +``` +cd /path/to/project +python -m venv .venv +source .venv/bin/activate +pip install -r requirements.txt +deactivate +``` + +### `pip install ` method + +``` +cd /path/to/project +python -m venv .venv +source .venv/bin/activate +pip install --upgrade pip + +# Required for the waveshare library +pip install Pillow numpy spidev + +# Required to interact with the gpio pins and the screen +pip install gpiozero rpi.gpio lgpio + +# Required to connect to the caldav server +pip install caldav + +# Required to use the open-meteo API +pip install openmeteo-requests +pip install requests-cache retry-requests numpy pandas + +deactivate +``` + +https://open-meteo.com/en/docs +https://www.waveshare.com/wiki/2.13inch_e-Paper_HAT+#Working_With_Raspberry_Pi +https://pypi.org/project/caldav/ + diff --git a/config.json b/config.json index ed44d6d..71dfeaa 100644 --- a/config.json +++ b/config.json @@ -12,7 +12,7 @@ "latitude": 40.4084, "longitude": -3.6876, "timezone": "Europe/Madrid", - "locales": "es_ES.UTF-8", + "locales": "en_GB.UTF-8", "caldavURL": "", "caldavUser": "", diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..763522b --- /dev/null +++ b/requirements.txt @@ -0,0 +1,33 @@ +attrs==25.1.0 +caldav==1.4.0 +cattrs==24.1.2 +certifi==2025.1.31 +charset-normalizer==3.4.1 +click==8.1.8 +colorzero==2.0 +flatbuffers==24.3.25 +gpiozero==2.0.1 +icalendar==6.1.1 +idna==3.10 +lgpio==0.2.2.0 +lxml==5.3.0 +numpy==2.2.2 +openmeteo_requests==1.3.0 +openmeteo_sdk==1.18.6 +pandas==2.2.3 +pillow==11.1.0 +platformdirs==4.3.6 +python-dateutil==2.9.0.post0 +pytz==2025.1 +recurring_ical_events==3.4.1 +requests==2.32.3 +requests-cache==1.2.1 +retry-requests==2.0.0 +RPi.GPIO==0.7.1 +six==1.17.0 +spidev==3.6 +tzdata==2025.1 +url-normalize==1.4.3 +urllib3==2.3.0 +vobject==0.9.9 +x_wr_timezone==2.0.0