# ASIC
Interfaz de línea de comandos para descargar los archivos de las publicaciones de liquidación del Mercado de Energía Mayorista MEM realizadas por el Administrador del Sistema de Intercambios Comerciales ASIC.
------
> **Requiere acceso al FTP del ASIC en `xmftps.xm.com.co`**
------
## Ejemplos
Antes de poder usar los comandos que usan el servir FTP de XM, debes proveer la información de autenticación (se recomienda usar variables de entorno).
```txt
$Env:ASIC_FTPS_HOST = "xmftps.xm.com.co"
$Env:ASIC_FTPS_USER = "Isamdnt\88888888"
$Env:ASIC_FTPS_PASSWORD = "m1MuySeCreTAClAV."
$Env:ASIC_FTPS_PORT = 210
```
1. Cuales versiones de liquidación se han publicado en los últimos días:
```txt
> asic pubs --days-old 20
Listing latest published settlements by ASIC in the last 20 days
2022-05:TX3 -- published: 2022-07-19
2022-06:TXR -- published: 2022-07-05
```
1. Listar los archivos publicados para los meses de mayo y junio de 2022 con version de liquidación .tx3:
```txt
> asic list --month 2022-06 --month 2022-05 --version .tx3
\INFORMACION_XM\PUBLICOK\SIC\COMERCIA\2022-05\adem0501.Tx3
\INFORMACION_XM\PUBLICOK\SIC\COMERCIA\2022-05\adem0502.Tx3
\INFORMACION_XM\PUBLICOK\SIC\COMERCIA\2022-05\adem0503.Tx3
\INFORMACION_XM\PUBLICOK\SIC\COMERCIA\2022-05\adem0504.Tx3
...
\INFORMACION_XM\PUBLICOK\SIC\COMERCIA\2022-05\pep0530.tx3
\INFORMACION_XM\PUBLICOK\SIC\COMERCIA\2022-05\pep0531.tx3
\INFORMACION_XM\PUBLICOK\SIC\COMERCIA\2022-05\sntie05.tx3
\INFORMACION_XM\PUBLICOK\SIC\COMERCIA\2022-05\afac05.tx3
\INFORMACION_XM\PUBLICOK\SIC\COMERCIA\2022-05\trsm05.tx3
\INFORMACION_XM\PUBLICOK\SIC\COMERCIA\2022-05\ldcbmr05.tx3
```
1. Descargar los archivos publicados para los meses de mayo y junio de 2022 con version de liquidación .tx3 a la carpeta local `./asic-files/`:
```txt
> asic download --month 2022-06 --month 2022-05 --version .tx3 asic-files
Dowloading files... ━━╸━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 6% 0:01:05
```
## CLI
Interfaz de línea de comandos (CLI).
### Instalación
1. Crear un ambiente virtual de python
```sh
python -m venv venv
```
1. Activar el ambiente virtual
```sh
.\venv\Scripts\activate
```
1. Instalar paquete
```sh
python -m pip install asic
```
### Ejecución
La CLI misma ofrece ayuda de como usarla.
La opción `--help` imprime la ayuda de cada comando en la pantalla.
```txt
> asic --help
Usage: asic [OPTIONS] COMMAND [ARGS]...
Commands:
download Download files from asic's ftp server to local DESTINATION folder.
list List files from asic's ftp server.
pubs Check latest published settlements in asic's website.
```
```txt
> asic pubs --help
Usage: asic pubs [OPTIONS]
Check latest published settlements in asic's website.
```
### Para tener en cuenta
Tener presente que no se está realizando la verificación de certificados del servidor de XM **neptuno.xm.com.co** al consultar las versiones de liquidación publicadas usando el comando **asic pubs**.
## Contribuir
Raw data
{
"_id": null,
"home_page": "https://github.com/enerBit/asic",
"name": "asic",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10, <3.11",
"maintainer_email": "",
"keywords": "asic xm colombia mem ftp development integration expertos mercados mercado energia mayorista",
"author": "enerBit",
"author_email": "jtamayoh@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/8e/e8/84887158d26b30a24e24447f6869a2015513a9c3b5cba30fd494317e82e2/asic-0.2.5.tar.gz",
"platform": null,
"description": "\n# ASIC\n\nInterfaz de l\u00ednea de comandos para descargar los archivos de las publicaciones de liquidaci\u00f3n del Mercado de Energ\u00eda Mayorista MEM realizadas por el Administrador del Sistema de Intercambios Comerciales ASIC.\n\n------\n\n> **Requiere acceso al FTP del ASIC en `xmftps.xm.com.co`**\n\n------\n\n## Ejemplos\n\nAntes de poder usar los comandos que usan el servir FTP de XM, debes proveer la informaci\u00f3n de autenticaci\u00f3n (se recomienda usar variables de entorno).\n\n```txt\n$Env:ASIC_FTPS_HOST = \"xmftps.xm.com.co\"\n$Env:ASIC_FTPS_USER = \"Isamdnt\\88888888\"\n$Env:ASIC_FTPS_PASSWORD = \"m1MuySeCreTAClAV.\"\n$Env:ASIC_FTPS_PORT = 210\n```\n\n1. Cuales versiones de liquidaci\u00f3n se han publicado en los \u00faltimos d\u00edas:\n\n```txt\n> asic pubs --days-old 20\nListing latest published settlements by ASIC in the last 20 days\n2022-05:TX3 -- published: 2022-07-19\n2022-06:TXR -- published: 2022-07-05\n```\n\n1. Listar los archivos publicados para los meses de mayo y junio de 2022 con version de liquidaci\u00f3n .tx3:\n\n```txt\n> asic list --month 2022-06 --month 2022-05 --version .tx3\n\\INFORMACION_XM\\PUBLICOK\\SIC\\COMERCIA\\2022-05\\adem0501.Tx3\n\\INFORMACION_XM\\PUBLICOK\\SIC\\COMERCIA\\2022-05\\adem0502.Tx3\n\\INFORMACION_XM\\PUBLICOK\\SIC\\COMERCIA\\2022-05\\adem0503.Tx3\n\\INFORMACION_XM\\PUBLICOK\\SIC\\COMERCIA\\2022-05\\adem0504.Tx3\n ...\n\\INFORMACION_XM\\PUBLICOK\\SIC\\COMERCIA\\2022-05\\pep0530.tx3\n\\INFORMACION_XM\\PUBLICOK\\SIC\\COMERCIA\\2022-05\\pep0531.tx3\n\\INFORMACION_XM\\PUBLICOK\\SIC\\COMERCIA\\2022-05\\sntie05.tx3\n\\INFORMACION_XM\\PUBLICOK\\SIC\\COMERCIA\\2022-05\\afac05.tx3\n\\INFORMACION_XM\\PUBLICOK\\SIC\\COMERCIA\\2022-05\\trsm05.tx3\n\\INFORMACION_XM\\PUBLICOK\\SIC\\COMERCIA\\2022-05\\ldcbmr05.tx3\n```\n\n1. Descargar los archivos publicados para los meses de mayo y junio de 2022 con version de liquidaci\u00f3n .tx3 a la carpeta local `./asic-files/`:\n\n```txt\n> asic download --month 2022-06 --month 2022-05 --version .tx3 asic-files\nDowloading files... \u2501\u2501\u2578\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501 6% 0:01:05\n```\n\n\n## CLI\n\nInterfaz de l\u00ednea de comandos (CLI).\n\n### Instalaci\u00f3n\n\n1. Crear un ambiente virtual de python\n\n```sh\npython -m venv venv\n```\n\n1. Activar el ambiente virtual\n\n```sh\n.\\venv\\Scripts\\activate\n```\n\n1. Instalar paquete\n\n```sh\npython -m pip install asic\n```\n\n### Ejecuci\u00f3n\n\nLa CLI misma ofrece ayuda de como usarla.\nLa opci\u00f3n `--help` imprime la ayuda de cada comando en la pantalla.\n\n```txt\n> asic --help \n\n Usage: asic [OPTIONS] COMMAND [ARGS]...\n\n Commands:\n download Download files from asic's ftp server to local DESTINATION folder.\n list List files from asic's ftp server.\n pubs Check latest published settlements in asic's website. \n```\n\n```txt\n> asic pubs --help\n\n Usage: asic pubs [OPTIONS]\n\n Check latest published settlements in asic's website.\n```\n\n### Para tener en cuenta\n\nTener presente que no se est\u00e1 realizando la verificaci\u00f3n de certificados del servidor de XM **neptuno.xm.com.co** al consultar las versiones de liquidaci\u00f3n publicadas usando el comando **asic pubs**.\n\n## Contribuir\n",
"bugtrack_url": null,
"license": "",
"summary": "Download and format ASIC files",
"version": "0.2.5",
"project_urls": {
"Homepage": "https://github.com/enerBit/asic",
"Source": "https://github.com/enerBit/asic.git"
},
"split_keywords": [
"asic",
"xm",
"colombia",
"mem",
"ftp",
"development",
"integration",
"expertos",
"mercados",
"mercado",
"energia",
"mayorista"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4993664e939bb042063304f62f1cc71fab565582c0ef25534b503c055c94df31",
"md5": "cf7f96ddcd89107731c1983906051ecc",
"sha256": "780c7193d9d0414706b94582b1c8dc5a389232d695bf7752907e48bdfb92d806"
},
"downloads": -1,
"filename": "asic-0.2.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cf7f96ddcd89107731c1983906051ecc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10, <3.11",
"size": 27130,
"upload_time": "2024-01-26T03:13:08",
"upload_time_iso_8601": "2024-01-26T03:13:08.570300Z",
"url": "https://files.pythonhosted.org/packages/49/93/664e939bb042063304f62f1cc71fab565582c0ef25534b503c055c94df31/asic-0.2.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8ee884887158d26b30a24e24447f6869a2015513a9c3b5cba30fd494317e82e2",
"md5": "43745e6513e4026c499ef90ec96266c0",
"sha256": "974dd188372a1c69444708984a0d25827668c0a39a81f2c2a36d1ff9b6c3e956"
},
"downloads": -1,
"filename": "asic-0.2.5.tar.gz",
"has_sig": false,
"md5_digest": "43745e6513e4026c499ef90ec96266c0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10, <3.11",
"size": 25120,
"upload_time": "2024-01-26T03:13:11",
"upload_time_iso_8601": "2024-01-26T03:13:11.984210Z",
"url": "https://files.pythonhosted.org/packages/8e/e8/84887158d26b30a24e24447f6869a2015513a9c3b5cba30fd494317e82e2/asic-0.2.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-26 03:13:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "enerBit",
"github_project": "asic",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "asic"
}
JSON
