Skip to content

Commit d09443c

Browse files
SantiagoFiolSantiagoFiol
committed
Primer commit del cliente de la API en Python.
0 parents  commit d09443c

23 files changed

Lines changed: 1275 additions & 0 deletions

‎.gitignore‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Archivos de desarrollo
2+
venv
3+
.vscode/
4+
__pycache__
5+
*.pyc
6+
7+
# Archivos de documentación
8+
docs/_build/
9+
docs/html/
10+
docs/*.doctrees
11+
docs/.buildinfo
12+
13+
# Archivos de distribución
14+
dist
15+
bhexpress.egg-info
16+
17+
# Archivos del sistema
18+
.DS_Store
19+
20+
# Archivos de tests
21+
tests/test.env
22+
tests/*.json
23+
tests/*.csv
24+
tests/*.pdf
25+
tests/*.html

‎.pypirc‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
[distutils]
2+
index-servers=pypi
3+
4+
[pypi]
5+
repository = https://pypi.python.org/pypi

‎.readthedocs.yaml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# .readthedocs.yaml
2+
# Read the Docs configuration file
3+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4+
5+
# Required
6+
version: 2
7+
8+
# Set the OS and Python version
9+
build:
10+
os: ubuntu-22.04
11+
tools:
12+
python: "3.11"
13+
14+
# Build documentation in the "docs/" directory with Sphinx
15+
sphinx:
16+
configuration: docs/conf.py
17+
18+
# Optionally build your docs in additional formats such as PDF and ePub
19+
# formats:
20+
# - pdf
21+
# - epub
22+
23+
# Declare the Python requirements required to build your documentation
24+
python:
25+
install:
26+
- requirements: requirements.txt

‎COPYING‎

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
GNU LESSER GENERAL PUBLIC LICENSE
2+
Version 3, 29 June 2007
3+
4+
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
5+
Everyone is permitted to copy and distribute verbatim copies
6+
of this license document, but changing it is not allowed.
7+
8+
9+
This version of the GNU Lesser General Public License incorporates
10+
the terms and conditions of version 3 of the GNU General Public
11+
License, supplemented by the additional permissions listed below.
12+
13+
0. Additional Definitions.
14+
15+
As used herein, "this License" refers to version 3 of the GNU Lesser
16+
General Public License, and the "GNU GPL" refers to version 3 of the GNU
17+
General Public License.
18+
19+
"The Library" refers to a covered work governed by this License,
20+
other than an Application or a Combined Work as defined below.
21+
22+
An "Application" is any work that makes use of an interface provided
23+
by the Library, but which is not otherwise based on the Library.
24+
Defining a subclass of a class defined by the Library is deemed a mode
25+
of using an interface provided by the Library.
26+
27+
A "Combined Work" is a work produced by combining or linking an
28+
Application with the Library. The particular version of the Library
29+
with which the Combined Work was made is also called the "Linked
30+
Version".
31+
32+
The "Minimal Corresponding Source" for a Combined Work means the
33+
Corresponding Source for the Combined Work, excluding any source code
34+
for portions of the Combined Work that, considered in isolation, are
35+
based on the Application, and not on the Linked Version.
36+
37+
The "Corresponding Application Code" for a Combined Work means the
38+
object code and/or source code for the Application, including any data
39+
and utility programs needed for reproducing the Combined Work from the
40+
Application, but excluding the System Libraries of the Combined Work.
41+
42+
1. Exception to Section 3 of the GNU GPL.
43+
44+
You may convey a covered work under sections 3 and 4 of this License
45+
without being bound by section 3 of the GNU GPL.
46+
47+
2. Conveying Modified Versions.
48+
49+
If you modify a copy of the Library, and, in your modifications, a
50+
facility refers to a function or data to be supplied by an Application
51+
that uses the facility (other than as an argument passed when the
52+
facility is invoked), then you may convey a copy of the modified
53+
version:
54+
55+
a) under this License, provided that you make a good faith effort to
56+
ensure that, in the event an Application does not supply the
57+
function or data, the facility still operates, and performs
58+
whatever part of its purpose remains meaningful, or
59+
60+
b) under the GNU GPL, with none of the additional permissions of
61+
this License applicable to that copy.
62+
63+
3. Object Code Incorporating Material from Library Header Files.
64+
65+
The object code form of an Application may incorporate material from
66+
a header file that is part of the Library. You may convey such object
67+
code under terms of your choice, provided that, if the incorporated
68+
material is not limited to numerical parameters, data structure
69+
layouts and accessors, or small macros, inline functions and templates
70+
(ten or fewer lines in length), you do both of the following:
71+
72+
a) Give prominent notice with each copy of the object code that the
73+
Library is used in it and that the Library and its use are
74+
covered by this License.
75+
76+
b) Accompany the object code with a copy of the GNU GPL and this license
77+
document.
78+
79+
4. Combined Works.
80+
81+
You may convey a Combined Work under terms of your choice that,
82+
taken together, effectively do not restrict modification of the
83+
portions of the Library contained in the Combined Work and reverse
84+
engineering for debugging such modifications, if you also do each of
85+
the following:
86+
87+
a) Give prominent notice with each copy of the Combined Work that
88+
the Library is used in it and that the Library and its use are
89+
covered by this License.
90+
91+
b) Accompany the Combined Work with a copy of the GNU GPL and this license
92+
document.
93+
94+
c) For a Combined Work that displays copyright notices during
95+
execution, include the copyright notice for the Library among
96+
these notices, as well as a reference directing the user to the
97+
copies of the GNU GPL and this license document.
98+
99+
d) Do one of the following:
100+
101+
0) Convey the Minimal Corresponding Source under the terms of this
102+
License, and the Corresponding Application Code in a form
103+
suitable for, and under terms that permit, the user to
104+
recombine or relink the Application with a modified version of
105+
the Linked Version to produce a modified Combined Work, in the
106+
manner specified by section 6 of the GNU GPL for conveying
107+
Corresponding Source.
108+
109+
1) Use a suitable shared library mechanism for linking with the
110+
Library. A suitable mechanism is one that (a) uses at run time
111+
a copy of the Library already present on the user's computer
112+
system, and (b) will operate properly with a modified version
113+
of the Library that is interface-compatible with the Linked
114+
Version.
115+
116+
e) Provide Installation Information, but only if you would otherwise
117+
be required to provide such information under section 6 of the
118+
GNU GPL, and only to the extent that such information is
119+
necessary to install and execute a modified version of the
120+
Combined Work produced by recombining or relinking the
121+
Application with a modified version of the Linked Version. (If
122+
you use option 4d0, the Installation Information must accompany
123+
the Minimal Corresponding Source and Corresponding Application
124+
Code. If you use option 4d1, you must provide the Installation
125+
Information in the manner specified by section 6 of the GNU GPL
126+
for conveying Corresponding Source.)
127+
128+
5. Combined Libraries.
129+
130+
You may place library facilities that are a work based on the
131+
Library side by side in a single library together with other library
132+
facilities that are not Applications and are not covered by this
133+
License, and convey such a combined library under terms of your
134+
choice, if you do both of the following:
135+
136+
a) Accompany the combined library with a copy of the same work based
137+
on the Library, uncombined with any other library facilities,
138+
conveyed under the terms of this License.
139+
140+
b) Give prominent notice with the combined library that part of it
141+
is a work based on the Library, and explaining where to find the
142+
accompanying uncombined form of the same work.
143+
144+
6. Revised Versions of the GNU Lesser General Public License.
145+
146+
The Free Software Foundation may publish revised and/or new versions
147+
of the GNU Lesser General Public License from time to time. Such new
148+
versions will be similar in spirit to the present version, but may
149+
differ in detail to address new problems or concerns.
150+
151+
Each version is given a distinguishing version number. If the
152+
Library as you received it specifies that a certain numbered version
153+
of the GNU Lesser General Public License "or any later version"
154+
applies to it, you have the option of following the terms and
155+
conditions either of that published version or of any later version
156+
published by the Free Software Foundation. If the Library as you
157+
received it does not specify a version number of the GNU Lesser
158+
General Public License, you may choose any version of the GNU Lesser
159+
General Public License ever published by the Free Software Foundation.
160+
161+
If the Library as you received it specifies that a proxy can decide
162+
whether future versions of the GNU Lesser General Public License shall
163+
apply, that proxy's public statement of acceptance of any version is
164+
permanent authorization for you to choose that version for the
165+
Library.

‎README.rst‎

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
BHExpress: Cliente de API en Python
2+
=====================================
3+
4+
.. image:: https://badge.fury.io/py/bhexpress.svg
5+
:target: https://pypi.org/project/bhexpress
6+
.. image:: https://img.shields.io/pypi/status/bhexpress.svg
7+
:target: https://pypi.org/project/bhexpress
8+
.. image:: https://img.shields.io/pypi/pyversions/bhexpress.svg
9+
:target: https://pypi.org/project/bhexpress
10+
.. image:: https://img.shields.io/pypi/l/bhexpress.svg
11+
:target: https://raw.githubusercontent.com/bhexpress/bhexpress-api-client-python/master/COPYING
12+
13+
Cliente para realizar la integración con los servicios web de `BHExpress <https://www.bhexpress.cl>`_ desde Python.
14+
15+
Instalación y actualización
16+
---------------------------
17+
18+
Instalar usando un entorno virtual y PIP con:
19+
20+
.. code:: shell
21+
22+
python3 -m venv venv
23+
source venv/bin/activate
24+
pip install bhexpress
25+
26+
Actualizar usando PIP con:
27+
28+
.. code:: shell
29+
30+
pip install bhexpress --upgrade
31+
32+
Modo de uso
33+
-----------
34+
35+
Se recomienda ver los ejemplos para más detalles. Lo que se muestra aquí es sólo
36+
una idea, y muy resumida:
37+
38+
Lo más simple, y recomendado, es usar una variable de entorno con el
39+
`token del usuario <https://bhexpress.cl/usuarios/perfil#token>`_,
40+
el cual será reconocida automáticamente por el cliente:
41+
42+
.. code:: python
43+
44+
from bhexpress.api_client.bhe.boletas import Boleta
45+
46+
client = Boleta()
47+
48+
boletas = self.client.listar()
49+
print(boletas)
50+
51+
Lo que hizo el ejemplo anterior es listar boletas emitidas en un resultado e imprimir dicho resultado en consola.
52+
53+
Ejemplos
54+
--------
55+
56+
Estos ejemplos provienen de la versión PHP. Para crear la versión Python de BHExpress,
57+
se tomó en cuenta dichos ejemplos.
58+
Los ejemplos cubren los siguientes casos:
59+
60+
- `001-boletas_listado.php`: obtener las boletas de un período.
61+
- `002-boleta_emitir.php`: emisitir una BHE.
62+
- `003-boleta_pdf.php`: descargar el PDF de una BHE.
63+
- `004-boleta_email.php`: enviar por email una BHE.
64+
- `005-boleta_anular.php`: anular una BHE.
65+
66+
Los ejemplos, por defecto, hacen uso de variables de entornos, si quieres usar
67+
esto debes tenerlas creadas, por ejemplo, en Windows 10, con:
68+
69+
.. code:: shell
70+
set BHEXPRESS_API_URL="https://bhexpress.cl"
71+
set BHEXPRESS_API_TOKEN="" # aquí el token obtenido en https://bhexpress.cl/usuarios/perfil#token
72+
set BHEXPRESS_EMISOR_RUT="" # aquí el RUT del emisor de las BHE
73+
74+
Ejemplo en la consola de Linux:
75+
76+
.. code:: shell
77+
export BHEXPRESS_API_URL="https://bhexpress.cl"
78+
export BHEXPRESS_API_TOKEN="" # aquí el token obtenido en https://bhexpress.cl/usuarios/perfil#token
79+
export BHEXPRESS_EMISOR_RUT="" # aquí el RUT del emisor de las BHE
80+
81+
82+
Licencia
83+
--------
84+
85+
Este programa es software libre: usted puede redistribuirlo y/o modificarlo
86+
bajo los términos de la GNU Lesser General Public License (LGPL) publicada
87+
por la Fundación para el Software Libre, ya sea la versión 3 de la Licencia,
88+
o (a su elección) cualquier versión posterior de la misma.
89+
90+
Este programa se distribuye con la esperanza de que sea útil, pero SIN
91+
GARANTÍA ALGUNA; ni siquiera la garantía implícita MERCANTIL o de APTITUD
92+
PARA UN PROPÓSITO DETERMINADO. Consulte los detalles de la GNU Lesser General
93+
Public License (LGPL) para obtener una información más detallada.
94+
95+
Debería haber recibido una copia de la GNU Lesser General Public License
96+
(LGPL) junto a este programa. En caso contrario, consulte
97+
`GNU Lesser General Public License <http://www.gnu.org/licenses/lgpl.html>`_.
98+
99+
Enlaces
100+
-------
101+
102+
- `Sitio web API Gateway <https://www.bhexpress.cl>`_.
103+
- `Código fuente en GitHub <https://github.com/bhexpress/bhexpress-api-client-python>`_.
104+
- `Paquete en PyPI <https://pypi.org/project/bhexpress>`_.
105+
- `Documentación en Read the Docs <https://bhexpress.readthedocs.io/es/latest>`_.

‎bhexpress/__init__.py‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
#
2+
# BHExpress: Cliente de API en Python.
3+
# Copyright (C) BHExpress <https://www.bhexpress.cl>
4+
#
5+
# Este programa es software libre: usted puede redistribuirlo y/o modificarlo
6+
# bajo los términos de la GNU Lesser General Public License (LGPL) publicada
7+
# por la Fundación para el Software Libre, ya sea la versión 3 de la Licencia,
8+
# o (a su elección) cualquier versión posterior de la misma.
9+
#
10+
# Este programa se distribuye con la esperanza de que sea útil, pero SIN
11+
# GARANTÍA ALGUNA; ni siquiera la garantía implícita MERCANTIL o de APTITUD
12+
# PARA UN PROPÓSITO DETERMINADO. Consulte los detalles de la GNU Lesser General
13+
# Public License (LGPL) para obtener una información más detallada.
14+
#
15+
# Debería haber recibido una copia de la GNU Lesser General Public License
16+
# (LGPL) junto a este programa. En caso contrario, consulte
17+
# <http://www.gnu.org/licenses/lgpl.html>.
18+
#

0 commit comments

Comments
 (0)