# DolarHoy
`DolarHoy` es una librería en Python que permite obtener las cotizaciones de diferentes tipos de dólar en Argentina desde el sitio web [DolarHoy](https://www.dolarhoy.com/). Utiliza las librerías `requests` y `BeautifulSoup` para hacer web scraping y extraer la información relevante.
## Instalación
Puedes instalar la librería utilizando `pip`:
```sh
pip install dolarhoy
```
## Uso
### Ejemplo Básico
A continuación se muestra un ejemplo básico de cómo utilizar la clase `DolarHoy` para obtener las cotizaciones del dólar.
```python
from dolarhoy import DolarHoy
# URL del sitio web
dolar_hoy = DolarHoy()
# Obtener todas las cotizaciones
all_data = dolar_hoy.get_all_data()
# Obtener la cotización del dólar blue
blue_price = dolar_hoy.get_blue_price()
# Obtener la cotización del dólar oficial
oficial_price = dolar_hoy.get_oficial_price()
# Obtener un resumen de todas las cotizaciones
summary = dolar_hoy.get_summary()
```
## Clases Enum
### `TipoDolar`
Una enumeración que representa los diferentes tipos de dólares:
- `BLUE`: "dolar_blue"
- `OFICIAL`: "dolar_oficial"
- `BOLSA`: "dolar_bolsa"
- `CONTADO_CON_LIQUI`: "contado_con_liqui"
- `TARJETA`: "dolar_tarjeta"
### `TipoOperacion`
Una enumeración que representa el tipo de operación:
- `COMPRA`: "compra"
- `VENTA`: "venta"
## Clase `DolarHoy`
### Constructor
#### `__init__(self, url: str = "https://www.dolarhoy.com")`
Inicializa una instancia de `DolarHoy` con la URL especificada. Por defecto, la URL es "https://www.dolarhoy.com".
### Métodos Privados
#### `_scrape_data(self)`
Extrae los datos de la URL y devuelve un diccionario que contiene las cotizaciones de diferentes tipos de dólares.
#### `_extract_cotizacion(self, soup, href)`
Extrae las cotizaciones (compra y venta) para un tipo específico de dólar del objeto BeautifulSoup y la URL proporcionada.
#### `_get_value(self, parent, class_name)`
Obtiene el valor de compra o venta del elemento HTML correspondiente.
### Métodos Públicos
#### `get_all_data(self) -> dict`
Devuelve un diccionario con todas las cotizaciones de los diferentes tipos de dólares.
#### `get_blue_price(self) -> dict`
Devuelve un diccionario con la cotización del dólar blue.
#### `get_oficial_price(self) -> dict`
Devuelve un diccionario con la cotización del dólar oficial.
#### `get_bolsa_price(self) -> dict`
Devuelve un diccionario con la cotización del dólar bolsa.
#### `get_contado_con_liqui_price(self) -> dict`
Devuelve un diccionario con la cotización del dólar contado con liqui.
#### `get_tarjeta_price(self) -> dict`
Devuelve un diccionario con la cotización del dólar tarjeta.
#### `get_price(self, tipo_dolar: TipoDolar, tipo_operacion: TipoOperacion) -> float`
Devuelve el precio de compra o venta para un tipo de dólar y operación específicos.
#### `get_all_prices(self, tipo_operacion: TipoOperacion) -> dict`
Devuelve un diccionario con todos los precios de compra o venta para todos los tipos de dólares.
#### `get_summary(self) -> str`
Devuelve un resumen en formato de cadena con todas las cotizaciones de los diferentes tipos de dólares, incluyendo los precios de compra y venta, la fuente y la URL de la fuente.
## Contribuciones
Si deseas contribuir a este proyecto, por favor sigue los siguientes pasos:
1. Haz un fork del repositorio.
2. Crea una nueva rama (`git checkout -b feature/nueva-funcionalidad`).
3. Realiza tus cambios y haz commit (`git commit -am 'Agrega nueva funcionalidad'`).
4. Sube tus cambios (`git push origin feature/nueva-funcionalidad`).
5. Crea un nuevo Pull Request.
## Licencia
Este proyecto está licenciado bajo la Licencia MIT. Consulta el archivo `LICENSE` para más detalles.
## Descargo de Responsabilidad
Esta librería es para fines educativos y no se asume responsabilidad alguna por los usos que se le den. La información utilizada por esta librería proviene del sitio [DolarHoy.com](https://www.dolarhoy.com), un sitio meramente informativo que no brinda consejo, recomendación, asesoramiento o invitación de ningún tipo para realizar actos y/u operaciones de cualquier clase.
Las fuentes de información citadas son de acceso público y los datos mostrados son elaborados sobre la base de dicha información. No se garantiza la precisión, veracidad, exactitud, integridad o vigencia de los datos.
El uso de la información proporcionada es responsabilidad exclusiva del usuario y no se asume responsabilidad por eventuales daños o perjuicios derivados de decisiones basadas en los datos obtenidos. Esta librería no mantiene acuerdos, asociaciones, alianzas o vínculos con los anunciantes de [DolarHoy.com](https://www.dolarhoy.com) y no se responsabiliza por los contenidos de las piezas publicitarias o banners en dicho sitio.
Raw data
{
"_id": null,
"home_page": "https://github.com/torrresagus/DolarHoy",
"name": "dolarhoy",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "python, dolar, dolarhoy, DolarHoy, web scraping, exchange rates, cotizaciones, dollar rates, argentina, financial data, beautifulsoup, requests",
"author": "Agustin Torres",
"author_email": "agustintorres2001@outlook.com.ar",
"download_url": "https://files.pythonhosted.org/packages/f3/65/7022ffad9e3c5060deb232c11d0ca824388f0790d445c8ac5910e5bb7419/dolarhoy-0.0.2.tar.gz",
"platform": null,
"description": "\r\n\r\n\r\n\r\n\r\n# DolarHoy\r\n\r\n\r\n\r\n`DolarHoy` es una librer\u00eda en Python que permite obtener las cotizaciones de diferentes tipos de d\u00f3lar en Argentina desde el sitio web [DolarHoy](https://www.dolarhoy.com/). Utiliza las librer\u00edas `requests` y `BeautifulSoup` para hacer web scraping y extraer la informaci\u00f3n relevante.\r\n\r\n\r\n\r\n## Instalaci\u00f3n\r\n\r\n\r\n\r\nPuedes instalar la librer\u00eda utilizando `pip`:\r\n\r\n\r\n\r\n```sh\r\n\r\npip install dolarhoy\r\n\r\n```\r\n\r\n\r\n\r\n## Uso\r\n\r\n\r\n\r\n### Ejemplo B\u00e1sico\r\n\r\n\r\n\r\nA continuaci\u00f3n se muestra un ejemplo b\u00e1sico de c\u00f3mo utilizar la clase `DolarHoy` para obtener las cotizaciones del d\u00f3lar.\r\n\r\n\r\n\r\n```python\r\n\r\nfrom dolarhoy import DolarHoy\r\n\r\n\r\n\r\n# URL del sitio web\r\n\r\ndolar_hoy = DolarHoy()\r\n\r\n\r\n\r\n# Obtener todas las cotizaciones\r\n\r\nall_data = dolar_hoy.get_all_data()\r\n\r\n\r\n\r\n# Obtener la cotizaci\u00f3n del d\u00f3lar blue\r\n\r\nblue_price = dolar_hoy.get_blue_price()\r\n\r\n\r\n\r\n# Obtener la cotizaci\u00f3n del d\u00f3lar oficial\r\n\r\noficial_price = dolar_hoy.get_oficial_price()\r\n\r\n\r\n\r\n# Obtener un resumen de todas las cotizaciones\r\n\r\nsummary = dolar_hoy.get_summary()\r\n\r\n```\r\n\r\n\r\n\r\n## Clases Enum\r\n\r\n\r\n\r\n### `TipoDolar`\r\n\r\nUna enumeraci\u00f3n que representa los diferentes tipos de d\u00f3lares:\r\n\r\n- `BLUE`: \"dolar_blue\"\r\n\r\n- `OFICIAL`: \"dolar_oficial\"\r\n\r\n- `BOLSA`: \"dolar_bolsa\"\r\n\r\n- `CONTADO_CON_LIQUI`: \"contado_con_liqui\"\r\n\r\n- `TARJETA`: \"dolar_tarjeta\"\r\n\r\n\r\n\r\n### `TipoOperacion`\r\n\r\nUna enumeraci\u00f3n que representa el tipo de operaci\u00f3n:\r\n\r\n- `COMPRA`: \"compra\"\r\n\r\n- `VENTA`: \"venta\"\r\n\r\n\r\n\r\n## Clase `DolarHoy`\r\n\r\n\r\n\r\n### Constructor\r\n\r\n\r\n\r\n#### `__init__(self, url: str = \"https://www.dolarhoy.com\")`\r\n\r\nInicializa una instancia de `DolarHoy` con la URL especificada. Por defecto, la URL es \"https://www.dolarhoy.com\".\r\n\r\n\r\n\r\n### M\u00e9todos Privados\r\n\r\n\r\n\r\n#### `_scrape_data(self)`\r\n\r\nExtrae los datos de la URL y devuelve un diccionario que contiene las cotizaciones de diferentes tipos de d\u00f3lares.\r\n\r\n\r\n\r\n#### `_extract_cotizacion(self, soup, href)`\r\n\r\nExtrae las cotizaciones (compra y venta) para un tipo espec\u00edfico de d\u00f3lar del objeto BeautifulSoup y la URL proporcionada.\r\n\r\n\r\n\r\n#### `_get_value(self, parent, class_name)`\r\n\r\nObtiene el valor de compra o venta del elemento HTML correspondiente.\r\n\r\n\r\n\r\n### M\u00e9todos P\u00fablicos\r\n\r\n\r\n\r\n#### `get_all_data(self) -> dict`\r\n\r\nDevuelve un diccionario con todas las cotizaciones de los diferentes tipos de d\u00f3lares.\r\n\r\n\r\n\r\n#### `get_blue_price(self) -> dict`\r\n\r\nDevuelve un diccionario con la cotizaci\u00f3n del d\u00f3lar blue.\r\n\r\n\r\n\r\n#### `get_oficial_price(self) -> dict`\r\n\r\nDevuelve un diccionario con la cotizaci\u00f3n del d\u00f3lar oficial.\r\n\r\n\r\n\r\n#### `get_bolsa_price(self) -> dict`\r\n\r\nDevuelve un diccionario con la cotizaci\u00f3n del d\u00f3lar bolsa.\r\n\r\n\r\n\r\n#### `get_contado_con_liqui_price(self) -> dict`\r\n\r\nDevuelve un diccionario con la cotizaci\u00f3n del d\u00f3lar contado con liqui.\r\n\r\n\r\n\r\n#### `get_tarjeta_price(self) -> dict`\r\n\r\nDevuelve un diccionario con la cotizaci\u00f3n del d\u00f3lar tarjeta.\r\n\r\n\r\n\r\n#### `get_price(self, tipo_dolar: TipoDolar, tipo_operacion: TipoOperacion) -> float`\r\n\r\nDevuelve el precio de compra o venta para un tipo de d\u00f3lar y operaci\u00f3n espec\u00edficos.\r\n\r\n\r\n\r\n#### `get_all_prices(self, tipo_operacion: TipoOperacion) -> dict`\r\n\r\nDevuelve un diccionario con todos los precios de compra o venta para todos los tipos de d\u00f3lares.\r\n\r\n\r\n\r\n#### `get_summary(self) -> str`\r\n\r\nDevuelve un resumen en formato de cadena con todas las cotizaciones de los diferentes tipos de d\u00f3lares, incluyendo los precios de compra y venta, la fuente y la URL de la fuente.\r\n\r\n\r\n\r\n\r\n\r\n## Contribuciones\r\n\r\n\r\n\r\nSi deseas contribuir a este proyecto, por favor sigue los siguientes pasos:\r\n\r\n\r\n\r\n1. Haz un fork del repositorio.\r\n\r\n2. Crea una nueva rama (`git checkout -b feature/nueva-funcionalidad`).\r\n\r\n3. Realiza tus cambios y haz commit (`git commit -am 'Agrega nueva funcionalidad'`).\r\n\r\n4. Sube tus cambios (`git push origin feature/nueva-funcionalidad`).\r\n\r\n5. Crea un nuevo Pull Request.\r\n\r\n\r\n\r\n## Licencia\r\n\r\n\r\n\r\nEste proyecto est\u00e1 licenciado bajo la Licencia MIT. Consulta el archivo `LICENSE` para m\u00e1s detalles.\r\n\r\n\r\n\r\n## Descargo de Responsabilidad\r\n\r\n\r\n\r\nEsta librer\u00eda es para fines educativos y no se asume responsabilidad alguna por los usos que se le den. La informaci\u00f3n utilizada por esta librer\u00eda proviene del sitio [DolarHoy.com](https://www.dolarhoy.com), un sitio meramente informativo que no brinda consejo, recomendaci\u00f3n, asesoramiento o invitaci\u00f3n de ning\u00fan tipo para realizar actos y/u operaciones de cualquier clase. \r\n\r\n\r\n\r\nLas fuentes de informaci\u00f3n citadas son de acceso p\u00fablico y los datos mostrados son elaborados sobre la base de dicha informaci\u00f3n. No se garantiza la precisi\u00f3n, veracidad, exactitud, integridad o vigencia de los datos. \r\n\r\n\r\n\r\nEl uso de la informaci\u00f3n proporcionada es responsabilidad exclusiva del usuario y no se asume responsabilidad por eventuales da\u00f1os o perjuicios derivados de decisiones basadas en los datos obtenidos. Esta librer\u00eda no mantiene acuerdos, asociaciones, alianzas o v\u00ednculos con los anunciantes de [DolarHoy.com](https://www.dolarhoy.com) y no se responsabiliza por los contenidos de las piezas publicitarias o banners en dicho sitio.\r\n",
"bugtrack_url": null,
"license": null,
"summary": "DolarHoy es una librer\u00eda en Python que facilita la obtenci\u00f3n de cotizaciones actualizadas de diferentes tipos de d\u00f3lar en Argentina, utilizando web scraping para extraer datos del sitio web DolarHoy.",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/torrresagus/DolarHoy"
},
"split_keywords": [
"python",
" dolar",
" dolarhoy",
" dolarhoy",
" web scraping",
" exchange rates",
" cotizaciones",
" dollar rates",
" argentina",
" financial data",
" beautifulsoup",
" requests"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6d760d1adb693994bee285ad9488a8393a42983533b4b318f97fd2b2108e1349",
"md5": "8fa478e81807304a9c6de83d60a01736",
"sha256": "a52993815d30b8ea1c17ed4052d0e867fa7476c59237e479bae52e38d1b6cb8c"
},
"downloads": -1,
"filename": "dolarhoy-0.0.2-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "8fa478e81807304a9c6de83d60a01736",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 6626,
"upload_time": "2024-06-24T14:35:51",
"upload_time_iso_8601": "2024-06-24T14:35:51.264371Z",
"url": "https://files.pythonhosted.org/packages/6d/76/0d1adb693994bee285ad9488a8393a42983533b4b318f97fd2b2108e1349/dolarhoy-0.0.2-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f3657022ffad9e3c5060deb232c11d0ca824388f0790d445c8ac5910e5bb7419",
"md5": "fe86e411c4c62e08adf943aaecaf6562",
"sha256": "29faf8d559c92e8aff0cd9d01bca6d4e977871f8a43f2e0d0989acb45586715f"
},
"downloads": -1,
"filename": "dolarhoy-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "fe86e411c4c62e08adf943aaecaf6562",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6472,
"upload_time": "2024-06-24T14:35:54",
"upload_time_iso_8601": "2024-06-24T14:35:54.108377Z",
"url": "https://files.pythonhosted.org/packages/f3/65/7022ffad9e3c5060deb232c11d0ca824388f0790d445c8ac5910e5bb7419/dolarhoy-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-24 14:35:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "torrresagus",
"github_project": "DolarHoy",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "dolarhoy"
}
JSON
