Skip to content

Commit e7dbe4e

Browse files
SantiagoFiolSantiagoFiol
committed
Primer commit del API Client Python de ContaFi. Incluye API Client, servicios, tests, documentación, workflows, entre otras cosas.
0 parents  commit e7dbe4e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

72 files changed

+4282
-0
lines changed

‎.github/workflows/ci.yml‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches:
6+
- master # Ejecuta pruebas al hacer push en la rama 'master'
7+
8+
env:
9+
env_var: ${{ vars.ENV_CONTEXT_VAR }}
10+
11+
jobs:
12+
test:
13+
runs-on: ubuntu-latest
14+
15+
strategy:
16+
matrix:
17+
python-version: ['3.11'] # Puedes cambiar las versiones según necesites
18+
19+
steps:
20+
- name: Check out repository code
21+
uses: actions/checkout@v3
22+
23+
- name: Setup Python ${{ matrix.python-version }}
24+
uses: actions/setup-python@v4
25+
with:
26+
python-version: ${{ matrix.python-version }} # Configura la versión de Python desde la matriz
27+
28+
- name: Install dependencies
29+
run: |
30+
python -m pip install --upgrade pip
31+
pip install -r requirements.txt
32+
33+
- name: Run Python tests
34+
env:
35+
CONTAFI_API_TOKEN: ${{ secrets.CONTAFI_API_TOKEN }}
36+
CONTAFI_CONTRIBUYENTE_RUT: ${{ vars.CONTAFI_CONTRIBUYENTE_RUT }}
37+
run: |
38+
make tests-readonly
39+
40+
- name: Upload pytest result report
41+
if: failure()
42+
uses: actions/upload-artifact@v4
43+
with:
44+
name: tests-results-python_${{ matrix.python-version }}.xml
45+
path: var/tests-results.xml
46+
47+
- name: Upload Coverage Report
48+
uses: actions/upload-artifact@v4
49+
with:
50+
name: tests-coverage-python_${{ matrix.python-version }}.xml
51+
path: var/tests-coverage.xml
52+
53+
- name: Display Python version
54+
run: python --version

‎.github/workflows/docs.yml‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: Docs
2+
3+
on:
4+
workflow_dispatch:
5+
push:
6+
branches:
7+
- master
8+
9+
jobs:
10+
docs:
11+
name: Docs
12+
runs-on: ubuntu-latest
13+
14+
steps:
15+
- name: Check out repository
16+
uses: actions/checkout@v4
17+
18+
- name: Set up Python
19+
uses: actions/setup-python@v4
20+
with:
21+
python-version: '3.11'
22+
23+
- name: Install Sphinx and dependencies
24+
run: |
25+
python -m pip install --upgrade pip
26+
pip install sphinx sphinx-rtd-theme
27+
28+
- name: Build Documentation
29+
run: |
30+
sphinx-build -b html docs/ build/docs
31+
32+
- name: Create CNAME file
33+
run: echo "api-client-python.docs.contafi.cl" > build/docs/CNAME
34+
35+
- name: Deploy to GitHub Pages
36+
if: success()
37+
uses: peaceiris/actions-gh-pages@v4
38+
with:
39+
github_token: ${{ secrets.GITHUB_TOKEN }}
40+
publish_dir: ./build/docs
41+
publish_branch: gh-pages

‎.gitignore‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
__pycache__
2+
test.env
3+
venv
4+
Dockerfile
5+
.vscode
6+
.DS_Store
7+
_build
8+
9+
tests/archivos/bhe_recibidas_pdf/*
10+
tests/archivos/bte_emitidas_pdf/*
11+
tests/archivos/bte_emitidas_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

‎.scrutinizer.yml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
checks:
2+
python: true
3+
4+
build:
5+
nodes:
6+
analysis:
7+
tests:
8+
override:
9+
- python-scrutinizer-run
10+
- command: make tests-readonly
11+
coverage:
12+
file: var/tests-coverage.xml
13+
format: clover
14+
environment:
15+
python:
16+
version: 3.11.10
17+
dependencies:
18+
before:
19+
- pip install -r requirements.txt
20+
21+
filter:
22+
paths:
23+
- contafi/*
24+
excluded_paths:
25+
- resources/*
26+
- tests/*
27+
- tools/*
28+
- var/*
29+
- vendor/*

‎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.

‎Makefile‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
all: dist
2+
3+
dist:
4+
python3 setup.py sdist
5+
6+
upload: dist
7+
twine upload dist/*
8+
9+
install-dev:
10+
python3 -m venv venv && source venv/bin/activate && pip install -r requirements.txt
11+
12+
tests: install-dev
13+
python tests/run.py
14+
15+
tests-readonly:
16+
python3 tests/run.py client.bhe.test_listar_bhes.TestListarBhes
17+
python3 tests/run.py client.bte.test_listar_btes.TestListarBtes
18+
python3 tests/run.py client.bte.test_calcular_monto_bruto.TestCalcularMontoBruto
19+
python3 tests/run.py client.bte.test_calcular_monto_liquido.TestCalcularMontoLiquido
20+
python3 tests/run.py client.contribuyentes.test_obtener_estadisticas.TestObtenerEstadisticas
21+
python3 tests/run.py client.contribuyentes.test_obtener_datos.TestObtenerDatos
22+
python3 tests/run.py client.contribuyentes.test_obtener_roles.TestObtenerRoles
23+
python3 tests/run.py client.facturacion.test_listar_clientes.TestListarClientes
24+
python3 tests/run.py client.facturacion.test_listar_proveedores.TestListarProveedores
25+
python3 tests/run.py client.ingresos_egresos.test_listar_movimientos.TestListarMovimientos
26+
python3 tests/run.py client.remuneraciones.test_listar_remuneraciones.TestListarRemuneraciones
27+
28+
docs:
29+
sphinx-apidoc -o docs contafi && sphinx-build -b html docs docs/_build/html
30+
31+
clean:
32+
rm -rf dist bhexpress.egg-info bhexpress/__pycache__ bhexpress/*.pyc

0 commit comments

Comments
 (0)