pluvia 0.1.0__tar.gz

pluvia-0.1.0/.git-cliff.toml

@@ -0,0 +1,59 @@
+# git-cliff configuration for pluvia
+
+[changelog]
+header = """
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+"""
+body = """
+{% if version %}\
+    ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
+{% else %}\
+    ## [unreleased]
+{% endif %}\
+{% for group, commits in commits | group_by(attribute="group") %}
+    ### {{ group | striptags | trim | upper_first }}
+    {% for commit in commits %}
+        - {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}
+    {% endfor %}
+{% endfor %}
+"""
+footer = """
+{% for release in releases %}
+    {% if release.version %}
+        [{{ release.version | trim_start_matches(pat="v") }}]: https://github.com/ericmiguel/pluvia/compare/{{ release.previous.version }}...{{ release.version }}
+    {% endif %}
+{% endfor %}
+"""
+trim = true
+
+[git]
+conventional_commits = true
+filter_unconventional = true
+split_commits = false
+commit_preprocessors = [
+    { pattern = '\\(\\([0-9]+\\)\\)$', replace = "" },
+]
+commit_parsers = [
+    { message = "^feat", group = "Features" },
+    { message = "^fix", group = "Bug Fixes" },
+    { message = "^doc", group = "Documentation" },
+    { message = "^docs", group = "Documentation" },
+    { message = "^perf", group = "Performance" },
+    { message = "^refactor", group = "Refactor" },
+    { message = "^style", group = "Styling" },
+    { message = "^test", group = "Testing" },
+    { message = "^chore\\(release\\): prepare for", skip = true },
+    { message = "^chore", group = "Miscellaneous Tasks" },
+    { body = "^.+breaking change", group = "Breaking Changes" },
+]
+protect_breaking_commits = false
+filter_commits = false
+topology_order = false
+sort_commits = "oldest"
+
+[bump]
+features_always_bump_minor = true
+breaking_always_bump_major = true

pluvia-0.1.0/.gitignore

@@ -0,0 +1,223 @@
+.cache
+
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+*.lcov
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi/*
+!.pixi/config.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule*
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

pluvia-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,27 @@
+repos:
+  - repo: local
+    hooks:
+      - id: ruff-check
+        name: ruff check
+        entry: pixi run -e dev ruff check src/ tests/
+        language: system
+        types: [python]
+        pass_filenames: false
+      - id: ruff-format
+        name: ruff format
+        entry: pixi run -e dev ruff format src/ tests/
+        language: system
+        types: [python]
+        pass_filenames: false
+      - id: pyrefly
+        name: pyrefly
+        entry: pixi run -e dev typecheck
+        language: system
+        types: [python]
+        pass_filenames: false
+      - id: pytest
+        name: pytest
+        entry: pixi run test
+        language: system
+        types: [python]
+        pass_filenames: false

pluvia-0.1.0/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "python-envs.defaultEnvManager": "ms-python.python:system"
+}

pluvia-0.1.0/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [0.1.0] - 2026-06-11
+
+### 🚀 Features
+
+- Initial release v0.1.0
+
+<!-- generated by git-cliff -->

pluvia-0.1.0/PKG-INFO

@@ -0,0 +1,13 @@
+Metadata-Version: 2.4
+Name: pluvia
+Version: 0.1.0
+Summary: Catalogação de estações hidrometeorológicas da ANA
+Author-email: Grenda Menezes <grenda.menezes@gmail.com>
+License: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Hydrology
+Requires-Python: >=3.11

pluvia-0.1.0/README.md

@@ -0,0 +1,136 @@
+![Pluvia logo](https://raw.githubusercontent.com/ericmiguel/pluvia/v0.1.0/assets/static/logo.png)
+
+Cliente para coleta de dados hidrometeorológicos do Brasil.
+
+## Instalação
+
+```bash
+pip install pluvia
+```
+
+## Como usar
+
+### Uso via CLI
+
+Após a instalação, o comando `pluvia` fica disponível no PATH do seu ambiente Python.
+
+Por conveniência, o pacote inclui contornos dos estados brasileiros (IBGE) embutidos.
+
+```bash
+pluvia --state SP --start 2026-01-01 --end 2026-06-30 --output ./dados
+```
+
+Para filtrar estações por qualquer limite vetorial (bacias hidrográficas, municípios, áreas de estudo etc.):
+
+```bash
+pluvia --shapefile ./bacias.shp --shape-column codigo --shape-id 01 --output ./dados
+```
+
+| Argumento         | Descrição                                                                                    |
+| ----------------- | -------------------------------------------------------------------------------------------- |
+| `--state`         | Sigla do estado brasileiro (ex: CE, SP, RJ). Obrigatório se `--shapefile` não for informado. |
+| `--start`         | Data de início no formato YYYY-MM-DD (padrão: ontem).                                        |
+| `--end`           | Data de fim no formato YYYY-MM-DD (padrão: hoje).                                            |
+| `--output`        | Diretório para salvar os dados CSV (padrão: diretório atual).                                |
+| `--rebuild`       | Ignora o cache e re-consulta todas as estações.                                              |
+| `--update-active` | Re-consulta estações ativas mesmo que o intervalo já esteja coberto (padrão: True).          |
+| `--shapefile`     | Caminho para shapefile vetorial customizado (.shp, .gpkg, .geojson).                         |
+| `--shape-column`  | Coluna de atributo do shapefile para filtrar (padrão: `acronym`).                            |
+| `--shape-id`      | Valor do ID na coluna de atributo do shapefile.                                              |
+| `--station-type`  | Tipo de estação: `fluviometrica`, `pluviometrica`, `telemetric`.                             |
+
+### Uso via API
+
+```python
+import pluvia
+
+client = pluvia.ANA()
+
+# Contornos embutidos (estados brasileiros)
+stations = client.get_stations(
+    contour="uf.shp", column="acronym", value="SP"
+)
+
+# Shapefile customizado
+stations = client.get_stations(
+    contour="./bacias.shp", column="codigo", value="01"
+)
+
+# Filtro por tipo de estação
+stations = client.get_stations(
+    contour="uf.shp", column="acronym", value="SP",
+    station_type="fluviometrica"
+)
+
+data = client.fetch_data(
+    stations=stations,
+    start="2026-01-01",
+    end="2026-06-30",
+    variable="chuva",  # chuva, nivel, vazao, cota
+    rebuild=True,  # força re-consulta completa (use na primeira execução)
+    update_active=True,  # re-consulta estações ativas mesmo com cache válido
+)
+```
+
+## Caching
+
+O serviço de dados da ANA (Agência Nacional de Águas) é lento e com limitações diversas.
+Para otimizar o uso dos dados, a biblioteca implementa uma estratégia de caching incremental
+e orientado a intervalos.
+
+1. Apenas os períodos ainda não baixados são consultados na API.
+2. O inventário de estações é re-buscado apenas quando expira (padrão: 7 dias).
+3. Estações sem dados são marcadas como inativas e re-consultadas com TTL dinâmico.
+4. Erros de rede consecutivos colocam a estação em cooldown de 24 h.
+
+O TTL dinâmico dita a frequência com que as estações são re-consultadas:
+
+- diariamente se tiveram dados recentes
+- a cada 3 dias se o último dado tem entre 30 dias e 1 ano
+- semanalmente se ainda mais antigo
+
+Essa estratégia visa reduzir tempo de coleta de dados ao mesmo tempo em que busca não
+desperdiçar estações que, por eventual (milagre) voltem a operar ou que tenham sofrido
+interrupções temporárias no serviço.
+
+## Desenvolvimento
+
+```bash
+pixi run -e dev lint        # ruff check
+pixi run -e dev format      # ruff format
+pixi run -e dev typecheck   # pyrefly
+pixi run test               # pytest
+```
+
+### Build e publicação no PyPI
+
+O projeto usa [Conventional Commits](https://www.conventionalcommits.org/) e versionamento
+semântico automatizado com `bump-my-version`. O changelog é gerado automaticamente com
+`git-cliff` a partir dos commits seguindo Conventional Commits.
+
+Configure um token em [pypi.org/manage/account/token](https://pypi.org/manage/account/token/) e salve em `~/.pypirc`.
+
+```ini
+# ~/.pypirc
+[pypi]
+username = __token__
+password = pypi-xxxxxxxxxxxx
+```
+
+Siga o fluxo para release de uma nova versão:
+
+```bash
+# 1. Atualizar versão (cria tag automaticamente)
+pixi run -e dev bump        # patch
+pixi run -e dev bump minor  # minor
+pixi run -e dev bump major  # major
+
+# 2. Atualizar changelog
+pixi run -e dev changelog
+
+# 3. Build
+pixi run -e dev build
+
+# 4. Publicar (requer API token no PyPI)
+pixi run -e dev publish
+```