Metadata-Version: 2.4
Name: aemetxfb
Version: 0.1.1
Summary: Access weather and climate data from AEMet (Spanish Meteorological Agency) without an API key
Project-URL: Homepage, https://codeberg.org/kikocorreoso/aemetxfb
Project-URL: Repository, https://codeberg.org/kikocorreoso/aemetxfb
Project-URL: Issues, https://codeberg.org/kikocorreoso/aemetxfb/issues
Project-URL: Documentation, https://kikocorreoso.codeberg.page/aemetxfb
Author: kikocorreoso
License-Expression: GPL-3.0-only
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.12
Requires-Dist: numpy>=2.4.3
Requires-Dist: pandas>=3.0.1
Provides-Extra: dev
Requires-Dist: ipython>=9.11.0; extra == 'dev'
Requires-Dist: matplotlib>=3.10.8; extra == 'dev'
Provides-Extra: docs
Requires-Dist: sphinx-rtd-theme>=3.1.0; extra == 'docs'
Requires-Dist: sphinx>=9.1.0; extra == 'docs'
Provides-Extra: tests
Requires-Dist: pytest>=9.0.2; extra == 'tests'
Requires-Dist: ruff>=0.15.7; extra == 'tests'
Description-Content-Type: text/markdown

[Spanish version](README.md)

# aemetxfb

Python package to access AEMet data without an API key.

## Documentation

You can find the documentation here: [https://kikocorreoso.codeberg.page/aemetxfb/](https://kikocorreoso.codeberg.page/aemetxfb/)

To build the documentation locally, clone the repository and, from the repository root:

```bash
# Install Sphinx dependencies
uv run pip install -e ".[docs]"

# Build HTML documentation
./scripts/build_docs.sh
```

The documentation will be generated in `docs/build/html/`. Open `index.html` in your browser to view it.

## Data notice

When using AEMET data, please note the following:

**© AEMET. Use and reproduction of this information is authorized provided that AEMET is cited as the source.**

## Comments

First of all, it is worth mentioning that most of the library was generated using LLMs and the code has been reviewed by humans. Hundreds of tests have been written, and the API has been reviewed through real-world usage. None of this guarantees that the library is bug-free. If you find any issues, please report them [here](https://codeberg.org/kikocorreoso/aemetxfb/issues) or, even better, submit your fix [here](https://codeberg.org/kikocorreoso/aemetxfb/pulls).

The goal has been to make the functionality as straightforward and simple as possible, with the code acting as a facilitator. If you think something could be expressed better, feel free to [discuss it](https://codeberg.org/kikocorreoso/aemetxfb/issues).

The data itself has its quirks (obsolete municipality names, duplicate names, etc.).

The documentation is generated automatically and all examples have been reviewed and verified to work correctly. In some cases, an example may not work due to the nature of the data. You will need to update the example with valid dates. This is also explained in the documentation, which is meant to be read.

## Contributing

To contribute, please read the guidelines [here](https://kikocorreoso.codeberg.page/aemetxfb/developing.html) first.
