meteocatpy 0.0.11 → 0.0.13

package/CHANGELOG.md

@@ -1,171 +1,187 @@
-## [0.0.11](https://github.com/figorr/meteocatpy/compare/v0.0.9...v0.0.10) (2024-12-10)
-
-### Bug Fixes
-
-* 0.0.11 ([4e1d638](https://github.com/figorr/meteocatpy/commit/4e1d6387200fb6cde2d06c448c178b108bbb2b92))
-
-
-## [0.0.10](https://github.com/figorr/meteocatpy/compare/v0.0.9...v0.0.10) (2024-12-10)
-
-
-### Bug Fixes
-
-* 0.0.10 ([93301e8](https://github.com/figorr/meteocatpy/commit/93301e82667ec85c79966da8a2b637c4d85e1b6a))
-* 0.0.11 ([4e1d638](https://github.com/figorr/meteocatpy/commit/4e1d6387200fb6cde2d06c448c178b108bbb2b92))
-* fix cache dir ([5c1d435](https://github.com/figorr/meteocatpy/commit/5c1d435f2310f3d0b33538f823efe64c0f3797b4))
-* fix poetry lock ([25f32b1](https://github.com/figorr/meteocatpy/commit/25f32b1cd078ee60ab877d99fe444ccfce116f42))
-* python 3.13 ([99390f4](https://github.com/figorr/meteocatpy/commit/99390f4745c803b9623255b39c29edf61dacfcf9))
-
-## [0.0.9](https://github.com/figorr/meteocatpy/compare/v0.0.8...v0.0.9) (2024-12-09)
-
-
-### Bug Fixes
-
-* 0.0.9 ([0cf6bf8](https://github.com/figorr/meteocatpy/commit/0cf6bf888c572c3477a1385a06a753fc0096fc95))
-* fix cache dir ([3cafd2f](https://github.com/figorr/meteocatpy/commit/3cafd2fb0ec2fcdf9d94cf3adb3fcb264aabeb9e))
-
-## [0.0.8](https://github.com/figorr/meteocatpy/compare/v0.0.7...v0.0.8) (2024-12-08)
-
-
-### Bug Fixes
-
-* 0.0.8 ([ae21e62](https://github.com/figorr/meteocatpy/commit/ae21e62c88b1ea20b94d5feb6eb8f5dfa07de509))
-* fix json data ([91df89c](https://github.com/figorr/meteocatpy/commit/91df89c9746588e20a2073770313de20fa8dd64b))
-
-## [0.0.7](https://github.com/figorr/meteocatpy/compare/v0.0.6...v0.0.7) (2024-12-07)
-
-
-### Bug Fixes
-
-* 0.0.7 ([7908841](https://github.com/figorr/meteocatpy/commit/7908841eee0b00b563b6b6266f4a6b71bc503ef2))
-* add github jobs ([d61a1e8](https://github.com/figorr/meteocatpy/commit/d61a1e846a5a34b505ca4520e68152bac21ace23))
-* add semantic-release ([cbecdd0](https://github.com/figorr/meteocatpy/commit/cbecdd05eade74445d5458100c3c42f2eaff4506))
-* CHANGELOG.md ([6cd6655](https://github.com/figorr/meteocatpy/commit/6cd665549663377ac4a73a20c6e5d4b8f6f859b9))
-* delete meteocat_cache ([05371e8](https://github.com/figorr/meteocatpy/commit/05371e8aa53365d5bbc027d1658e154957e225fe))
-* fix Content-Type : application.json for headers ([a79bb1c](https://github.com/figorr/meteocatpy/commit/a79bb1ced0a1f2def294b5964840ea938c469d57))
-* fix data recovery data ([fc93719](https://github.com/figorr/meteocatpy/commit/fc93719d7d601810771bd89dcd8715686843f836))
-* fix gitlab jobs ([7ee5b57](https://github.com/figorr/meteocatpy/commit/7ee5b5714e27b3f9031d5b9b81fe100e1064f0da))
-* ignore node_modules ([8b7f87c](https://github.com/figorr/meteocatpy/commit/8b7f87c5bf6b08211925824fd02dd0fdbbfced9b))
-* ignore pytest_cache ([99e99ba](https://github.com/figorr/meteocatpy/commit/99e99baf9a79529e63a0db47c76c7b150432f566))
-* new repo file structure ([bd7e438](https://github.com/figorr/meteocatpy/commit/bd7e438040255ddbcc375fd67469704a83bf5dfe))
-
-## v0.0.1 (2024-11-27)
-
-### Bug Fixes
-
-- Version 0.0.3
-  ([`3be4659`](https://github.com/figorr/meteocatpy/commit/3be4659a5df47b942f3d24594dc1140eecb65388))
-
-- Version 0.0.3
-  ([`987d7c8`](https://github.com/figorr/meteocatpy/commit/987d7c89f770f11aa37267815b799dd90d6230be))
-
-- Fix version 0.0.3
-  ([`6caaa46`](https://github.com/figorr/meteocatpy/commit/6caaa460dbee29f10a8566e0925ceddb94e4167e))
-
-- Version to 0.0.2
-  ([`0d47a4c`](https://github.com/figorr/meteocatpy/commit/0d47a4c1d8f64d0f6b32a79b909cda79ef236825))
-
-- 0.0.1
-  ([`a840913`](https://github.com/figorr/meteocatpy/commit/a840913c7cab075bf7b242ecbf0c93c0471f27f1))
-
-- Fix version to 0.0.2
-  ([`9c1b294`](https://github.com/figorr/meteocatpy/commit/9c1b294faa060988ecf41fbebcb01345ec940dce))
-
-- 0.0.1
-  ([`304baee`](https://github.com/figorr/meteocatpy/commit/304baeef7d988b3d38a39a2064230ccf3e34e5b5))
-
-- Version 0.0.2
-  ([`94fe6d1`](https://github.com/figorr/meteocatpy/commit/94fe6d1c6637c69d38eaec6b86463e260d1faf7f))
-
-- Python 3.12
-  ([`3b41f89`](https://github.com/figorr/meteocatpy/commit/3b41f895150a335f9cce7df3932d162bd8a6ed2e))
-
-- 0.0.1
-  ([`21b136e`](https://github.com/figorr/meteocatpy/commit/21b136e53b20484ca451b8ae7ea346723e343cd0))
-
-- New repo file structure
-  ([`d4369e5`](https://github.com/figorr/meteocatpy/commit/d4369e5e3048fee4fb7edf445814f4e765178d4d))
-
-- Set town_id as codi_municipi and variable_id as codi_variable
-  ([`8cfa246`](https://github.com/figorr/meteocatpy/commit/8cfa2465a949bfd46c60d7a4d824bd41eb5af507))
-
-- Set town_id as codi
-  ([`f4f1ee4`](https://github.com/figorr/meteocatpy/commit/f4f1ee403d16620e57c02e66771aa6b3483b6a89))
-
-- Set station_id as codiEstacio
-  ([`d8d75e4`](https://github.com/figorr/meteocatpy/commit/d8d75e484c3c191e7db70a20db9ce27e2b7d182c))
-
-- Add new classes
-  ([`aebd5c1`](https://github.com/figorr/meteocatpy/commit/aebd5c1011a9ba53ddcf239fa6f6ab2c9fc052a4))
-
-- Fix status code UnknownAPIError
-  ([`d611d42`](https://github.com/figorr/meteocatpy/commit/d611d42ddc12ff792d53894ba0c8007a1a9678ab))
-
-- Fix status code for UnknownAPIError
-  ([`3f4606b`](https://github.com/figorr/meteocatpy/commit/3f4606b5ec023254cb73efb2d5cf306974533898))
-
-- Fix README
-  ([`1c5553d`](https://github.com/figorr/meteocatpy/commit/1c5553d9b430563cb35f2d53fd51b4be00bf25aa))
-
-- Add MeteocatSymbols
-  ([`f30b115`](https://github.com/figorr/meteocatpy/commit/f30b1150d0bc78908287a1ef72827590a089f003))
-
-- Fix tests
-  ([`93cdcfd`](https://github.com/figorr/meteocatpy/commit/93cdcfd753d4ab7770ae85ad7c4e035802b8e9d2))
-
-- Set symbol categories
-  ([`88a5016`](https://github.com/figorr/meteocatpy/commit/88a5016935d6103183672a79bf0423e0893cefa1))
-
-- Include new classes
-  ([`f4ce82b`](https://github.com/figorr/meteocatpy/commit/f4ce82bffef80a884e02962548d6f5da7466e3b1))
-
-- Improved error handling
-  ([`03699b7`](https://github.com/figorr/meteocatpy/commit/03699b74791db3bb695d9613a215aee3da6a9929))
-
-- Improved error handling
-  ([`786005a`](https://github.com/figorr/meteocatpy/commit/786005a43435cb2217575dd1e528ff4f5a403e35))
-
-- Improved error handling
-  ([`295b356`](https://github.com/figorr/meteocatpy/commit/295b3560864e4420008aa80cbc01c96e1fbb67f8))
-
-- Delete test files
-  ([`33f3751`](https://github.com/figorr/meteocatpy/commit/33f3751e645bda30a70475efe5404f6f4ad0f96f))
-
-- Fix integration_test
-  ([`b7e8024`](https://github.com/figorr/meteocatpy/commit/b7e8024760401537d9ad28e026d4948383d9db3e))
-
-- Add predictions resource url
-  ([`d88e457`](https://github.com/figorr/meteocatpy/commit/d88e45777671c5726859c4b817a5ea02a7462ae4))
-
-- Add predictions to client
-  ([`e292acb`](https://github.com/figorr/meteocatpy/commit/e292acb3aa68415f3dd06d8ed2030fe2b18b9cb4))
-
-- Fix base_url
-  ([`3850642`](https://github.com/figorr/meteocatpy/commit/3850642390eb85962e0ac2d13d6b72effd985f53))
-
-- Add new dependencies
-  ([`dd7ff23`](https://github.com/figorr/meteocatpy/commit/dd7ff23fc7131187dd2c82cd57c2e6bcabfcea42))
-
-- Readme
-  ([`cb7cc7f`](https://github.com/figorr/meteocatpy/commit/cb7cc7fa33a388dde7e13563bc060d8a8a7265cf))
-
-- Readme
-  ([`21d88e7`](https://github.com/figorr/meteocatpy/commit/21d88e77ea206905161f09223f2d6f265958e98d))
-
-- Add test_client
-  ([`d878f74`](https://github.com/figorr/meteocatpy/commit/d878f7403716254b49203dc8f4589177bcbabc56))
-
-- Fix _secrets
-  ([`3adf076`](https://github.com/figorr/meteocatpy/commit/3adf076060718b0445ab9ff606e396ce2974433a))
-
-- Fix const.py
-  ([`c268acc`](https://github.com/figorr/meteocatpy/commit/c268acc417d8e8a550d2d74636e35e4268802dc6))
-
-- Fix description
-  ([`7afeb64`](https://github.com/figorr/meteocatpy/commit/7afeb643c5c8d906f4a497a9d177d264d25506dd))
-
-- Fix interface.py
-  ([`6dbc4c0`](https://github.com/figorr/meteocatpy/commit/6dbc4c0a1d644e58cb8c9b69b5ff812759ab25c0))
-
-- Add filetree
-  ([`1d1fad8`](https://github.com/figorr/meteocatpy/commit/1d1fad8ee1a50757396b6fd8ba8f8c77b243e1dd))
+## [0.0.13](https://github.com/figorr/meteocatpy/compare/v0.0.12...v0.0.13) (2024-12-11)
+
+
+### Bug Fixes
+
+* 0.0.13 ([1bdf3e7](https://github.com/figorr/meteocatpy/commit/1bdf3e7632156c0f033b483ac0ab5f159ed65be4))
+* fix cache dir ([6303383](https://github.com/figorr/meteocatpy/commit/6303383e7cbf2efad27d288adf89c6ea58dbc9c4))
+
+## [0.0.12](https://github.com/figorr/meteocatpy/compare/v0.0.11...v0.0.12) (2024-12-11)
+
+
+### Bug Fixes
+
+* 0.0.12 ([81aa152](https://github.com/figorr/meteocatpy/commit/81aa1528202661eb4854e37f9b1880f798d9457e))
+* fix cache dir ([8df49f9](https://github.com/figorr/meteocatpy/commit/8df49f97fd8f6645dae9db9f53a94a44395447ff))
+
+## [0.0.11](https://github.com/figorr/meteocatpy/compare/v0.0.9...v0.0.10) (2024-12-10)
+
+### Bug Fixes
+
+* 0.0.11 ([4e1d638](https://github.com/figorr/meteocatpy/commit/4e1d6387200fb6cde2d06c448c178b108bbb2b92))
+
+
+## [0.0.10](https://github.com/figorr/meteocatpy/compare/v0.0.9...v0.0.10) (2024-12-10)
+
+
+### Bug Fixes
+
+* 0.0.10 ([93301e8](https://github.com/figorr/meteocatpy/commit/93301e82667ec85c79966da8a2b637c4d85e1b6a))
+* 0.0.11 ([4e1d638](https://github.com/figorr/meteocatpy/commit/4e1d6387200fb6cde2d06c448c178b108bbb2b92))
+* fix cache dir ([5c1d435](https://github.com/figorr/meteocatpy/commit/5c1d435f2310f3d0b33538f823efe64c0f3797b4))
+* fix poetry lock ([25f32b1](https://github.com/figorr/meteocatpy/commit/25f32b1cd078ee60ab877d99fe444ccfce116f42))
+* python 3.13 ([99390f4](https://github.com/figorr/meteocatpy/commit/99390f4745c803b9623255b39c29edf61dacfcf9))
+
+## [0.0.9](https://github.com/figorr/meteocatpy/compare/v0.0.8...v0.0.9) (2024-12-09)
+
+
+### Bug Fixes
+
+* 0.0.9 ([0cf6bf8](https://github.com/figorr/meteocatpy/commit/0cf6bf888c572c3477a1385a06a753fc0096fc95))
+* fix cache dir ([3cafd2f](https://github.com/figorr/meteocatpy/commit/3cafd2fb0ec2fcdf9d94cf3adb3fcb264aabeb9e))
+
+## [0.0.8](https://github.com/figorr/meteocatpy/compare/v0.0.7...v0.0.8) (2024-12-08)
+
+
+### Bug Fixes
+
+* 0.0.8 ([ae21e62](https://github.com/figorr/meteocatpy/commit/ae21e62c88b1ea20b94d5feb6eb8f5dfa07de509))
+* fix json data ([91df89c](https://github.com/figorr/meteocatpy/commit/91df89c9746588e20a2073770313de20fa8dd64b))
+
+## [0.0.7](https://github.com/figorr/meteocatpy/compare/v0.0.6...v0.0.7) (2024-12-07)
+
+
+### Bug Fixes
+
+* 0.0.7 ([7908841](https://github.com/figorr/meteocatpy/commit/7908841eee0b00b563b6b6266f4a6b71bc503ef2))
+* add github jobs ([d61a1e8](https://github.com/figorr/meteocatpy/commit/d61a1e846a5a34b505ca4520e68152bac21ace23))
+* add semantic-release ([cbecdd0](https://github.com/figorr/meteocatpy/commit/cbecdd05eade74445d5458100c3c42f2eaff4506))
+* CHANGELOG.md ([6cd6655](https://github.com/figorr/meteocatpy/commit/6cd665549663377ac4a73a20c6e5d4b8f6f859b9))
+* delete meteocat_cache ([05371e8](https://github.com/figorr/meteocatpy/commit/05371e8aa53365d5bbc027d1658e154957e225fe))
+* fix Content-Type : application.json for headers ([a79bb1c](https://github.com/figorr/meteocatpy/commit/a79bb1ced0a1f2def294b5964840ea938c469d57))
+* fix data recovery data ([fc93719](https://github.com/figorr/meteocatpy/commit/fc93719d7d601810771bd89dcd8715686843f836))
+* fix gitlab jobs ([7ee5b57](https://github.com/figorr/meteocatpy/commit/7ee5b5714e27b3f9031d5b9b81fe100e1064f0da))
+* ignore node_modules ([8b7f87c](https://github.com/figorr/meteocatpy/commit/8b7f87c5bf6b08211925824fd02dd0fdbbfced9b))
+* ignore pytest_cache ([99e99ba](https://github.com/figorr/meteocatpy/commit/99e99baf9a79529e63a0db47c76c7b150432f566))
+* new repo file structure ([bd7e438](https://github.com/figorr/meteocatpy/commit/bd7e438040255ddbcc375fd67469704a83bf5dfe))
+
+## v0.0.1 (2024-11-27)
+
+### Bug Fixes
+
+- Version 0.0.3
+  ([`3be4659`](https://github.com/figorr/meteocatpy/commit/3be4659a5df47b942f3d24594dc1140eecb65388))
+
+- Version 0.0.3
+  ([`987d7c8`](https://github.com/figorr/meteocatpy/commit/987d7c89f770f11aa37267815b799dd90d6230be))
+
+- Fix version 0.0.3
+  ([`6caaa46`](https://github.com/figorr/meteocatpy/commit/6caaa460dbee29f10a8566e0925ceddb94e4167e))
+
+- Version to 0.0.2
+  ([`0d47a4c`](https://github.com/figorr/meteocatpy/commit/0d47a4c1d8f64d0f6b32a79b909cda79ef236825))
+
+- 0.0.1
+  ([`a840913`](https://github.com/figorr/meteocatpy/commit/a840913c7cab075bf7b242ecbf0c93c0471f27f1))
+
+- Fix version to 0.0.2
+  ([`9c1b294`](https://github.com/figorr/meteocatpy/commit/9c1b294faa060988ecf41fbebcb01345ec940dce))
+
+- 0.0.1
+  ([`304baee`](https://github.com/figorr/meteocatpy/commit/304baeef7d988b3d38a39a2064230ccf3e34e5b5))
+
+- Version 0.0.2
+  ([`94fe6d1`](https://github.com/figorr/meteocatpy/commit/94fe6d1c6637c69d38eaec6b86463e260d1faf7f))
+
+- Python 3.12
+  ([`3b41f89`](https://github.com/figorr/meteocatpy/commit/3b41f895150a335f9cce7df3932d162bd8a6ed2e))
+
+- 0.0.1
+  ([`21b136e`](https://github.com/figorr/meteocatpy/commit/21b136e53b20484ca451b8ae7ea346723e343cd0))
+
+- New repo file structure
+  ([`d4369e5`](https://github.com/figorr/meteocatpy/commit/d4369e5e3048fee4fb7edf445814f4e765178d4d))
+
+- Set town_id as codi_municipi and variable_id as codi_variable
+  ([`8cfa246`](https://github.com/figorr/meteocatpy/commit/8cfa2465a949bfd46c60d7a4d824bd41eb5af507))
+
+- Set town_id as codi
+  ([`f4f1ee4`](https://github.com/figorr/meteocatpy/commit/f4f1ee403d16620e57c02e66771aa6b3483b6a89))
+
+- Set station_id as codiEstacio
+  ([`d8d75e4`](https://github.com/figorr/meteocatpy/commit/d8d75e484c3c191e7db70a20db9ce27e2b7d182c))
+
+- Add new classes
+  ([`aebd5c1`](https://github.com/figorr/meteocatpy/commit/aebd5c1011a9ba53ddcf239fa6f6ab2c9fc052a4))
+
+- Fix status code UnknownAPIError
+  ([`d611d42`](https://github.com/figorr/meteocatpy/commit/d611d42ddc12ff792d53894ba0c8007a1a9678ab))
+
+- Fix status code for UnknownAPIError
+  ([`3f4606b`](https://github.com/figorr/meteocatpy/commit/3f4606b5ec023254cb73efb2d5cf306974533898))
+
+- Fix README
+  ([`1c5553d`](https://github.com/figorr/meteocatpy/commit/1c5553d9b430563cb35f2d53fd51b4be00bf25aa))
+
+- Add MeteocatSymbols
+  ([`f30b115`](https://github.com/figorr/meteocatpy/commit/f30b1150d0bc78908287a1ef72827590a089f003))
+
+- Fix tests
+  ([`93cdcfd`](https://github.com/figorr/meteocatpy/commit/93cdcfd753d4ab7770ae85ad7c4e035802b8e9d2))
+
+- Set symbol categories
+  ([`88a5016`](https://github.com/figorr/meteocatpy/commit/88a5016935d6103183672a79bf0423e0893cefa1))
+
+- Include new classes
+  ([`f4ce82b`](https://github.com/figorr/meteocatpy/commit/f4ce82bffef80a884e02962548d6f5da7466e3b1))
+
+- Improved error handling
+  ([`03699b7`](https://github.com/figorr/meteocatpy/commit/03699b74791db3bb695d9613a215aee3da6a9929))
+
+- Improved error handling
+  ([`786005a`](https://github.com/figorr/meteocatpy/commit/786005a43435cb2217575dd1e528ff4f5a403e35))
+
+- Improved error handling
+  ([`295b356`](https://github.com/figorr/meteocatpy/commit/295b3560864e4420008aa80cbc01c96e1fbb67f8))
+
+- Delete test files
+  ([`33f3751`](https://github.com/figorr/meteocatpy/commit/33f3751e645bda30a70475efe5404f6f4ad0f96f))
+
+- Fix integration_test
+  ([`b7e8024`](https://github.com/figorr/meteocatpy/commit/b7e8024760401537d9ad28e026d4948383d9db3e))
+
+- Add predictions resource url
+  ([`d88e457`](https://github.com/figorr/meteocatpy/commit/d88e45777671c5726859c4b817a5ea02a7462ae4))
+
+- Add predictions to client
+  ([`e292acb`](https://github.com/figorr/meteocatpy/commit/e292acb3aa68415f3dd06d8ed2030fe2b18b9cb4))
+
+- Fix base_url
+  ([`3850642`](https://github.com/figorr/meteocatpy/commit/3850642390eb85962e0ac2d13d6b72effd985f53))
+
+- Add new dependencies
+  ([`dd7ff23`](https://github.com/figorr/meteocatpy/commit/dd7ff23fc7131187dd2c82cd57c2e6bcabfcea42))
+
+- Readme
+  ([`cb7cc7f`](https://github.com/figorr/meteocatpy/commit/cb7cc7fa33a388dde7e13563bc060d8a8a7265cf))
+
+- Readme
+  ([`21d88e7`](https://github.com/figorr/meteocatpy/commit/21d88e77ea206905161f09223f2d6f265958e98d))
+
+- Add test_client
+  ([`d878f74`](https://github.com/figorr/meteocatpy/commit/d878f7403716254b49203dc8f4589177bcbabc56))
+
+- Fix _secrets
+  ([`3adf076`](https://github.com/figorr/meteocatpy/commit/3adf076060718b0445ab9ff606e396ce2974433a))
+
+- Fix const.py
+  ([`c268acc`](https://github.com/figorr/meteocatpy/commit/c268acc417d8e8a550d2d74636e35e4268802dc6))
+
+- Fix description
+  ([`7afeb64`](https://github.com/figorr/meteocatpy/commit/7afeb643c5c8d906f4a497a9d177d264d25506dd))
+
+- Fix interface.py
+  ([`6dbc4c0`](https://github.com/figorr/meteocatpy/commit/6dbc4c0a1d644e58cb8c9b69b5ff812759ab25c0))
+
+- Add filetree
+  ([`1d1fad8`](https://github.com/figorr/meteocatpy/commit/1d1fad8ee1a50757396b6fd8ba8f8c77b243e1dd))

package/README.md

@@ -1,62 +1,62 @@
-# Meteocat Python Package for Meteocat Home Assistant Integration
-
-[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
-[![Python version compatibility](https://img.shields.io/pypi/pyversions/meteocatpy)](https://pypi.org/project/meteocatpy)
-[![pipeline status](https://gitlab.com/figorr/meteocatpy/badges/master/pipeline.svg)](https://gitlab.com/figorr/meteocatpy/commits/master)
-
-
-`meteocatpy` is a Python package to interact with the Meteocat API. Allows you to obtain meteorological data and lists of municipalities from the Meteocat API.
-
-**NOTE:** Meteocat API requires to use an API_KEY, you should ask to (https://apidocs.meteocat.gencat.cat/documentacio/acces-ciutada-i-administracio/)
-
-# Installation
-
-You can install the package from PyPI using `pip`:
-```bash
-pip install meteocatpy
-```
-
-```bash
-from meteocatpy.client import MeteocatClient
-
-# Replace 'tu_api_key' with your actual API key
-api_key = "tu_api_key"
-client = MeteocatClient(api_key)
-
-# Get a list of municipalities (asynchronous call)
-municipis = await client.get_municipis()
-print(municipis)
-```
-
-# Credits
-
-This is a personal project.
-
-Authors:
-- Figorr
-
-# Contributing
-
-If you would like to contribute to this project, please open an issue or create a pull request. I'd be happy to review your contributions!
-
-1.  [Check for open features/bugs](https://gitlab.com/figorr/meteocatpy/issues)
-    or [initiate a discussion on one](https://gitlab.com/figorr/meteocatpy/issues/new).
-2.  [Fork the repository](https://gitlab.com/figorr/meteocatpy/forks/new).
-3.  Install the dev environment: `make init`.
-4.  Enter the virtual environment: `pipenv shell`
-5.  Code your new feature or bug fix.
-6.  Write a test that covers your new functionality.
-7.  Update `README.md` with any new documentation.
-8.  Run tests and ensure 100% code coverage for your contribution: `make coverage`
-9.  Ensure you have no linting errors: `make lint`
-10. Ensure you have typed your code correctly: `make typing`
-11. Add yourself to `AUTHORS.md`.
-12. Submit a pull request!
-
-# License
-
-[Apache-2.0](LICENSE). By providing a contribution, you agree the contribution is licensed under Apache-2.0.
-
-# API Reference
-
+# Meteocat Python Package for Meteocat Home Assistant Integration
+
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Python version compatibility](https://img.shields.io/pypi/pyversions/meteocatpy)](https://pypi.org/project/meteocatpy)
+[![pipeline status](https://gitlab.com/figorr/meteocatpy/badges/master/pipeline.svg)](https://gitlab.com/figorr/meteocatpy/commits/master)
+
+
+`meteocatpy` is a Python package to interact with the Meteocat API. Allows you to obtain meteorological data and lists of municipalities from the Meteocat API.
+
+**NOTE:** Meteocat API requires to use an API_KEY, you should ask to (https://apidocs.meteocat.gencat.cat/documentacio/acces-ciutada-i-administracio/)
+
+# Installation
+
+You can install the package from PyPI using `pip`:
+```bash
+pip install meteocatpy
+```
+
+```bash
+from meteocatpy.client import MeteocatClient
+
+# Replace 'tu_api_key' with your actual API key
+api_key = "tu_api_key"
+client = MeteocatClient(api_key)
+
+# Get a list of municipalities (asynchronous call)
+municipis = await client.get_municipis()
+print(municipis)
+```
+
+# Credits
+
+This is a personal project.
+
+Authors:
+- Figorr
+
+# Contributing
+
+If you would like to contribute to this project, please open an issue or create a pull request. I'd be happy to review your contributions!
+
+1.  [Check for open features/bugs](https://gitlab.com/figorr/meteocatpy/issues)
+    or [initiate a discussion on one](https://gitlab.com/figorr/meteocatpy/issues/new).
+2.  [Fork the repository](https://gitlab.com/figorr/meteocatpy/forks/new).
+3.  Install the dev environment: `make init`.
+4.  Enter the virtual environment: `pipenv shell`
+5.  Code your new feature or bug fix.
+6.  Write a test that covers your new functionality.
+7.  Update `README.md` with any new documentation.
+8.  Run tests and ensure 100% code coverage for your contribution: `make coverage`
+9.  Ensure you have no linting errors: `make lint`
+10. Ensure you have typed your code correctly: `make typing`
+11. Add yourself to `AUTHORS.md`.
+12. Submit a pull request!
+
+# License
+
+[Apache-2.0](LICENSE). By providing a contribution, you agree the contribution is licensed under Apache-2.0.
+
+# API Reference
+
 [See the docs 📚](https://apidocs.meteocat.gencat.cat/section/informacio-general/).

package/filetree.py

@@ -1,48 +1,48 @@
-import subprocess
-import os
-
-def generate_file_tree():
-    # Ruta donde se generará el archivo
-    output_file = 'filetree.txt'
-
-    # Ejecutar el comando git ls-files para obtener los archivos no ignorados
-    git_command = ['git', 'ls-files']
-    try:
-        # Captura de la salida del comando git
-        git_files = subprocess.check_output(git_command).decode('utf-8').splitlines()
-
-        # Crear una estructura de árbol
-        tree = {}
-
-        # Construir el árbol de directorios
-        for file in git_files:
-            parts = file.split('/')  # Separar la ruta del archivo por '/'
-            current = tree
-            for part in parts[:-1]:  # Recorremos todos los directorios
-                current = current.setdefault(part, {})
-            current[parts[-1]] = None  # El archivo final se marca como 'None'
-        
-        # Función recursiva para imprimir el árbol con la indentación correcta
-        def print_tree(directory, indent=""):
-            for name, subdirectory in directory.items():
-                if subdirectory is None:
-                    # Si es un archivo, lo imprimimos
-                    f.write(f"{indent}├── {name}\n")
-                else:
-                    # Si es un directorio, lo imprimimos y recursivamente llamamos a print_tree
-                    f.write(f"{indent}└── {name}/\n")
-                    print_tree(subdirectory, indent + "    ")
-
-        # Crear el archivo y escribir la estructura del árbol con codificación UTF-8
-        with open(output_file, 'w', encoding='utf-8') as f:
-            print_tree(tree)
-
-        print(f"Árbol de directorios generado en: {os.path.abspath(output_file)}")
-
-    except subprocess.CalledProcessError as e:
-        print(f"Error al ejecutar el comando: {e}")
-    except Exception as e:
-        print(f"Ocurrió un error inesperado: {e}")
-
-if __name__ == "__main__":
-    generate_file_tree()
+import subprocess
+import os
+
+def generate_file_tree():
+    # Ruta donde se generará el archivo
+    output_file = 'filetree.txt'
+
+    # Ejecutar el comando git ls-files para obtener los archivos no ignorados
+    git_command = ['git', 'ls-files']
+    try:
+        # Captura de la salida del comando git
+        git_files = subprocess.check_output(git_command).decode('utf-8').splitlines()
+
+        # Crear una estructura de árbol
+        tree = {}
+
+        # Construir el árbol de directorios
+        for file in git_files:
+            parts = file.split('/')  # Separar la ruta del archivo por '/'
+            current = tree
+            for part in parts[:-1]:  # Recorremos todos los directorios
+                current = current.setdefault(part, {})
+            current[parts[-1]] = None  # El archivo final se marca como 'None'
+        
+        # Función recursiva para imprimir el árbol con la indentación correcta
+        def print_tree(directory, indent=""):
+            for name, subdirectory in directory.items():
+                if subdirectory is None:
+                    # Si es un archivo, lo imprimimos
+                    f.write(f"{indent}├── {name}\n")
+                else:
+                    # Si es un directorio, lo imprimimos y recursivamente llamamos a print_tree
+                    f.write(f"{indent}└── {name}/\n")
+                    print_tree(subdirectory, indent + "    ")
+
+        # Crear el archivo y escribir la estructura del árbol con codificación UTF-8
+        with open(output_file, 'w', encoding='utf-8') as f:
+            print_tree(tree)
+
+        print(f"Árbol de directorios generado en: {os.path.abspath(output_file)}")
+
+    except subprocess.CalledProcessError as e:
+        print(f"Error al ejecutar el comando: {e}")
+    except Exception as e:
+        print(f"Ocurrió un error inesperado: {e}")
+
+if __name__ == "__main__":
+    generate_file_tree()