Black y Docstrings

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -0,0 +1,68 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath(".."))
+
+
+# -- Project information -----------------------------------------------------
+
+project = "pyFlowCL"
+copyright = "2021, mariofix"
+author = "mariofix"
+
+# The full version, including alpha/beta/rc tags
+release = "1.0.5"
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ["sphinx.ext.autodoc"]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = "es"
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+on_rtd = os.environ.get("READTHEDOCS", None) == "True"
+
+if not on_rtd:  # only import and set the theme if we're building docs locally
+    import sphinx_theme
+
+    html_theme = "stanford_theme"
+    html_theme_path = [sphinx_theme.get_html_theme_path("stanford_theme")]
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ["_static"]

docs/index.rst

@@ -0,0 +1,19 @@
+.. pyFlowCL documentation master file, created by
+   sphinx-quickstart on Sat Jul 10 19:22:59 2021.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to pyFlowCL's documentation!
+====================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   modules
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/modules.rst

@@ -0,0 +1,7 @@
+pyflowcl
+======
+
+.. toctree::
+   :maxdepth: 4
+
+   pyflowcl

docs/pyflowcl.rst

@@ -0,0 +1,53 @@
+pyflowcl package
+================
+
+Submodules
+----------
+
+pyflowcl.Clients module
+-----------------------
+
+.. automodule:: pyflowcl.Clients
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyflowcl.Customer module
+------------------------
+
+.. automodule:: pyflowcl.Customer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyflowcl.Payment module
+-----------------------
+
+.. automodule:: pyflowcl.Payment
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyflowcl.Refund module
+----------------------
+
+.. automodule:: pyflowcl.Refund
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyflowcl.models module
+----------------------
+
+.. automodule:: pyflowcl.models
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: pyflowcl
+   :members:
+   :undoc-members:
+   :show-inheritance:

pyflowcl/models.py

@@ -1,3 +1,8 @@
+"""
+pyflowcl.models
+~~~~~~~~~~~~~~~~
+Modelos de distintos objetos del paquete
+"""
 from __future__ import annotations
 
 from dataclasses import dataclass
@@ -6,7 +11,7 @@
 
 @dataclass
 class Error:
-    """ Objeto para definir un error """
+    """Objeto para definir un error"""
 
     code: Optional[float] = None
     message: Optional[str] = None
@@ -24,7 +29,7 @@ def from_dict(d: Dict[str, Any]) -> Error:
 
 @dataclass
 class PaymentStatus:
-    """ Objeto para obtener el estado de un pago """
+    """Objeto para obtener el estado de un pago"""
 
     flow_order: Optional[int] = None
     commerce_order: Optional[str] = None
@@ -72,7 +77,7 @@ def from_dict(d: Dict[str, Any]) -> PaymentStatus:
 
 @dataclass
 class PaymentRequest:
-    """ Objeto para generar una URL de pago """
+    """Objeto para generar una URL de pago"""
 
     amount: float = 0
     apiKey: str = "API_KEY"
@@ -126,7 +131,7 @@ def from_dict(d: Dict[str, Any]) -> PaymentRequest:
 
 @dataclass
 class PaymentRequestEmail:
-    """ Objeto para generar un correo electronico de pago """
+    """Objeto para generar un correo electronico de pago"""
 
     amount: float = 0
     apiKey: str = "API_KEY"
@@ -183,7 +188,7 @@ def from_dict(d: Dict[str, Any]) -> PaymentRequestEmail:
 
 @dataclass
 class PaymentResponse:
-    """ Objeto respuesta de una creacion de pago """
+    """Objeto respuesta de una creacion de pago"""
 
     url: Optional[str] = None
     token: Optional[str] = None
@@ -204,7 +209,7 @@ def from_dict(d: Dict[str, Any]) -> PaymentResponse:
 
 @dataclass
 class PaymentList:
-    """ Lista de pagos """
+    """Lista de pagos"""
 
     total: Optional[float] = None
     hasMore: Optional[bool] = None
@@ -225,7 +230,7 @@ def from_dict(d: Dict[str, Any]) -> PaymentList:
 
 @dataclass
 class RefundRequest:
-    """ Refund  Request object """
+    """Refund  Request object"""
 
     amount: float = 0
     apiKey: str = "API_KEY"
@@ -261,7 +266,7 @@ def from_dict(d: Dict[str, Any]) -> RefundRequest:
 
 @dataclass
 class RefundStatus:
-    """ Refund object """
+    """Refund object"""
 
     flowRefundOrder: int = 0
     date: str = ""
@@ -288,7 +293,7 @@ def from_dict(d: Dict[str, Any]) -> RefundStatus:
 
 @dataclass
 class Customer:
-    """ Customer Object """
+    """Customer Object"""
 
     created: str = ""
     creditCardType: Optional[str] = None
@@ -330,7 +335,7 @@ def from_dict(d: Dict[str, Any]) -> Customer:
 
 @dataclass
 class CustomerRequest:
-    """ CustomerRequest Object """
+    """CustomerRequest Object"""
 
     apiKey: str = ""
     customerId: str = ""
@@ -360,7 +365,7 @@ def from_dict(d: Dict[str, Any]) -> CustomerRequest:
 
 @dataclass
 class CustomerList:
-    """ Lista de Clientes """
+    """Lista de Clientes"""
 
     total: Optional[float] = None
     hasMore: Optional[bool] = None
@@ -381,7 +386,7 @@ def from_dict(d: Dict[str, Any]) -> CustomerList:
 
 @dataclass
 class CustomerRegisterResponse:
-    """ Objeto respuesta """
+    """Objeto respuesta"""
 
     url: Optional[str] = None
     token: Optional[str] = None
@@ -399,7 +404,7 @@ def from_dict(d: Dict[str, Any]) -> CustomerRegisterResponse:
 
 @dataclass
 class CustomerRegisterStatusResponse:
-    """ Objeto respuesta """
+    """Objeto respuesta"""
 
     creditCardType: str = ""
     customerId: str = ""
@@ -423,7 +428,7 @@ def from_dict(d: Dict[str, Any]) -> CustomerRegisterStatusResponse:
 
 @dataclass
 class CustomerChargeRequest:
-    """ Objeto para generar una URL de pago """
+    """Objeto para generar una URL de pago"""
 
     amount: float = 0
     apiKey: str = "API_KEY"
@@ -456,7 +461,7 @@ def from_dict(d: Dict[str, Any]) -> CustomerChargeRequest:
 
 @dataclass
 class CollectResponse:
-    """ Objeto para CollectResponse """
+    """Objeto para CollectResponse"""
 
     commerce_order: Optional[str] = None
     flow_order: Optional[float] = None
@@ -493,7 +498,7 @@ def from_dict(d: Dict[str, Any]) -> CollectResponse:
 
 @dataclass
 class CollectRequest:
-    """ Objeto para generar un correo electronico de pago """
+    """Objeto para generar un correo electronico de pago"""
 
     amount: float = 0
     apiKey: str = "API_KEY"
@@ -552,7 +557,7 @@ def from_dict(d: Dict[str, Any]) -> CollectRequest:
 
 @dataclass
 class CollectObject:
-    """ Objeto de cobro para un lote de cobros """
+    """Objeto de cobro para un lote de cobros"""
 
     customer_id: str
     commerce_order: str

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyflowcl"
-version = "1.0.4"
+version = "1.0.5"
 description = "Cliente para comunicacion con flowAPI-3 de flow.cl"
 authors = ["Mario Hernandez <[email protected]>"]
 license = "MIT"
@@ -25,6 +25,9 @@ pytest = "*"
 pytest-pep8 = "*"
 black = "*"
 tox = "*"
+thankyou = "^0.0.1"
+sphinx = "*"
+sphinx-theme = "*"
 
 [build-system]
 requires = ["poetry>=0.12"]

tests/test_pyflow.py

@@ -2,4 +2,4 @@
 
 
 def test_version():
-    assert __version__ == "1.0.3"
+    assert __version__ == "1.0.5"