cl-forge 0.1.0__cp314-cp314-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

cl_forge/__init__.py

@@ -0,0 +1,20 @@
+"""Simple yet powerful Chilean and other tools written in Rust and Python."""
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from . import cmf, verify
+
+__all__ = (
+    "cmf",
+    "verify",
+)
+
+
+import importlib
+
+
+def __getattr__(name: str):
+    if name in __all__:
+        return importlib.import_module(f".{name}", __name__)
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")

cl_forge/cmf.py

@@ -0,0 +1,17 @@
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from .core._rs_cl_forge import _rs_cmf as _cmf # noqa
+
+    CmfClient = _cmf.CmfClient
+
+__all__ = (
+    "CmfClient",
+)
+
+
+def __getattr__(name: str):
+    if name in __all__:
+        from .core._rs_cl_forge import _rs_cmf as _cmf  # noqa
+        return getattr(_cmf, name)
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")

cl_forge/cmf.pyi

@@ -0,0 +1,75 @@
+from __future__ import annotations
+
+from typing import Literal
+
+class CmfClient:
+    """
+    Client for interacting with the Chilean CMF API.
+
+    The API is free to use, but has a limit of 10.000 monthly requests per
+    user and requires an API key for authentication, which can be requested in
+    `Contact`_ and is usually sent to the given email during the day.
+
+    .. _Contact: https://api.cmfchile.cl/api_cmf/contactanos.jsp
+
+    Attributes
+    ----------
+    api_key: str
+        Truncated API Key to at most 5 characters.
+    base_url: str
+        The base URL for the CMF API.
+
+    Notes
+    -----
+    - CMF stands for `Comisión para el Mercado Financiero`.
+    """
+    def __init__(self, api_key: str) -> None:
+        """
+        Initializes the CMF client with the provided API key.
+
+        Parameters
+        ----------
+        api_key: str
+            The API key for authenticating with the CMF API.
+        """
+
+    def get(
+            self,
+            path: str,
+            format: Literal['json', 'xml'] = 'json', # noqa: A002
+            params: dict | None = None
+    ) -> dict | str:
+        """
+        Sends a GET request to the specified CMF API endpoint. See the `API Docs`_
+        for all the available endpoints.
+
+        .. _API Docs: https://api.cmfchile.cl/documentacion/index.html
+
+        Parameters
+        ----------
+        path : str
+            The API endpoint path. Must start with '/'.
+        format : Literal['json', 'xml']
+            The format of the response. Must be lower case 'json' or 'xml'.
+            Defaults to 'json'.
+        params : dict | None
+            Optional query parameters for the request.
+
+        Raises
+        ------
+        EmptyPath
+            If the path is empty.
+        InvalidPath
+            If the path doesn't start with '/'.
+        BadStatus
+            If the request doesn't succeed (status code != 200).
+        ValueError
+            If the format is not 'json' or 'xml', or if fail to parse JSON the
+            response.
+
+        Returns
+        -------
+        dict | str
+            The response from the CMF API. Returns a dict if format is 'json', 
+            and a str if format is 'xml'.
+        """

cl_forge/verify.py

@@ -0,0 +1,25 @@
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from .core._rs_cl_forge import _rs_verify as _verify  # noqa
+
+    Ppu = _verify.Ppu
+    calculate_verifier = _verify.calculate_verifier
+    normalize_ppu = _verify.normalize_ppu
+    ppu_to_numeric = _verify.ppu_to_numeric
+    validate_rut = _verify.validate_rut
+
+__all__ = (
+    "Ppu",
+    "calculate_verifier",
+    "normalize_ppu",
+    "ppu_to_numeric",
+    "validate_rut",
+)
+
+
+def __getattr__(name: str):
+    if name in __all__:
+        from .core._rs_cl_forge import _rs_verify as _verify  # noqa
+        return getattr(_verify, name)
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")

cl_forge/verify.pyi

@@ -0,0 +1,140 @@
+from __future__ import annotations
+
+class Ppu:
+    """
+    Represents a Chilean PPU (vehicle license plate).
+
+    Attributes
+    ----------
+    raw : str
+        The input PPU.
+    numeric : str
+        The numeric representation of the PPU.
+    normalized: str
+        The normalized PPU.
+    verifier: str
+        The calculated verifier digit of the PPU.
+    format: str
+        The detected format of the PPU. Supported formats:
+
+        - `LLLNN`  -> 3 letters followed by 2 digits
+        - `LLLNNN` -> 4 letters followed by 3 digits
+        - `LLLLNN` -> 4 letters followed by 2 digits
+        - `LLNNNN` -> 2 letters followed by 4 digits
+    complete: str
+        The normalized PPU with the verifier digit, separated by '-'.
+    """
+
+    def __init__(self, ppu: str, /) -> None:
+        """
+        Initializes a Ppu instance by normalizing the input PPU and
+        calculating its numeric representation.
+
+        Parameters
+        ----------
+        ppu : str
+            Chilean PPU (vehicle license plate).
+        """
+
+    @property
+    def raw(self) -> str:
+        """The input PPU."""
+
+    @property
+    def numeric(self) -> str:
+        """The numeric representation of the PPU."""
+
+    @property
+    def normalized(self) -> str:
+        """The normalized PPU."""
+
+    @property
+    def verifier(self) -> str:
+        """The calculated verifier digit of the PPU."""
+
+    @property
+    def format(self) -> str:
+        """The detected format of the PPU."""
+
+    @property
+    def complete(self) -> str:
+        """The normalized PPU with the verifier digit, separated by '-'."""
+
+
+def calculate_verifier(digits: str, /) -> str:
+    """
+    Calculates the verifier digit (DV) of a Chilean RUT/RUN using Module 11
+    algorithm.
+
+    Parameters
+    ----------
+    digits : str
+        Numeric part of the RUT/RUN (digits only).
+
+    Returns
+    -------
+    str
+        Verifier digit: '0'..'9' or 'K'.
+    """
+
+
+def ppu_to_numeric(ppu: str, /) -> str:
+    """
+    Converts a Chilean PPU (vehicle license plate) into its numeric
+    representation.
+
+    Parameters
+    ----------
+    ppu : str
+        Chilean PPU (vehicle license plate). Supported formats:
+
+        - `LLLNN`  -> 3 letters followed by 2 digits
+        - `LLLNNN` -> 4 letters followed by 3 digits
+        - `LLLLNN` -> 4 letters followed by 2 digits
+        - `LLNNNN` -> 2 letters followed by 4 digits
+
+    Returns
+    -------
+    str
+        Numeric representation of the PPU.
+    """
+
+
+def normalize_ppu(ppu: str, /) -> str:
+    """
+    Normalizes a given PPU string to a standard format.
+
+    If the format is recognized as `LLLNN` (3 letters followed by 2 digits),
+    the function prepends a '0' after the first 3 characters, resulting in a
+    normalized format of `LLL0NN`. Otherwise, the `ppu` is returned as-is, but
+    trimmed in uppercase.
+
+    Parameters
+    ----------
+    ppu : Chilean PPU (vehicle license plate).
+
+    Returns
+    -------
+    str
+        Normalized PPU.
+    """
+
+
+def validate_rut(digits: str, verifier: str, /) -> bool:
+    """
+    Validates a Chilean RUT/RUN by checking if the provided verifier digit
+    matches the calculated one using Module 11 algorithm.
+
+    Parameters
+    ----------
+    digits : str
+        Numeric part of the RUT/RUN (digits only).
+    verifier : str
+        Verifier digit to validate against: "0".."9" or "K".
+
+    Returns
+    -------
+    bool
+        `True` if the verifier is valid for the given correlative,
+        `False` otherwise.
+    """

cl_forge-0.1.0.dist-info/METADATA

@@ -0,0 +1,109 @@
+Metadata-Version: 2.4
+Name: cl-forge
+Version: 0.1.0
+License-File: LICENSE
+Summary: Simple yet powerful Chilean and other tools written in Rust and Python.
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Homepage, https://github.com/mschiaff/cl-forge
+Project-URL: Issues, https://github.com/mschiaff/cl-forge/issues
+Project-URL: Repository, https://github.com/mschiaff/cl-forge.git
+
+[![Python package](https://github.com/mschiaff/cl-forge/actions/workflows/python-package.yml/badge.svg?branch=main)](https://github.com/mschiaff/cl-forge/actions/workflows/python-package.yml)
+
+# cl-forge 🇨🇱
+
+Simple yet powerful Chilean and other tools written in Rust and Python.
+
+`cl-forge` provides a collection of high-performance utilities for common Chilean data formats and API integrations. The core logic is implemented in Rust for maximum speed, with a clean and easy-to-use Python interface.
+
+## Features
+
+- **Verify**: Efficiently validate and manipulate Chilean RUT/RUN and PPU (License Plates).
+- **CMF API**: A simple client to interact with the Chilean Financial Market Commission (CMF) API.
+- **High Performance**: Core logic written in Rust.
+- **Lazy Loading**: Submodules are loaded only when needed to keep the initial import fast.
+- **Type Safety**: Full type hints and `.pyi` stubs for excellent IDE support.
+
+## Installation
+
+```bash
+pip install cl-forge
+```
+
+Or using `uv`:
+
+```bash
+uv add cl-forge
+```
+
+## Usage
+
+### Verification (RUT & PPU)
+
+```python
+from cl_forge import verify
+
+# Validate a RUT
+is_valid = verify.validate_rut("12345678", "5")
+print(f"RUT is valid: {is_valid}")
+
+# Calculate RUT verifier
+dv = verify.calculate_verifier("12345678")
+print(f"Verifier digit: {dv}")
+
+# Work with PPUs (License Plates)
+ppu = verify.Ppu("PHZF55")
+print(f"Normalized: {ppu.normalized}")  # PHZF55
+print(f"Verifier: {ppu.verifier}")      # K
+print(f"Complete: {ppu.complete}")      # PHZF55-K
+```
+
+### CMF API Client
+
+To use the CMF API, you need an API key. You can request one at [CMF Chile](https://api.cmfchile.cl/api_cmf/contactanos.jsp).
+
+```python
+from cl_forge.cmf import CmfClient
+
+client = CmfClient(api_key="your_api_key_here")
+
+# Get IPC data
+ipc_data = client.get(path="/ipc")
+print(ipc_data) # {'IPCs': [{'Valor': '-0,2', 'Fecha': '2025-12-01'}]}
+```
+
+See the [CMF API documentation](https://api.cmfchile.cl/documentacion/index.html) for details about the available endpoints.
+
+## Development
+
+This project uses [maturin](https://github.com/PyO3/maturin) to build the Rust extension.
+
+### Setup
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/mschiaff/cl-forge.git
+   cd cl-forge
+   ```
+
+2. Install development dependencies (using [uv](https://github.com/astral-sh/uv)):
+   ```bash
+   uv sync --all-groups
+   ```
+
+3. Build the Rust extension in develop mode:
+   ```bash
+   uv run maturin develop
+   ```
+
+### Running Tests
+
+```bash
+uv run pytest
+```
+
+## License
+
+This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE) file for details.
+

cl_forge-0.1.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+cl_forge/__init__.py,sha256=wCRxfZKTzi_3w2SNISfgu82AFk2MqaetzonVoj3Myfg,409
+cl_forge/cmf.py,sha256=sFXogntp1MwSlgG-taVEsoBP4GYRsGgWgI3oKUX3IxQ,400
+cl_forge/cmf.pyi,sha256=uCIk5jvS1BQibYFwQRIEzQ1Pqdhr5yJlPTzouO1cOB0,2205
+cl_forge/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cl_forge/core/_rs_cl_forge.cpython-314-x86_64-linux-gnu.so,sha256=Sb31iUllQC_U_Un_WphNn13BbW_SUta5HGZWgHTQ1XM,8546288
+cl_forge/verify.py,sha256=TsXqkJB05E6-GlbVAEQe0OPWUUwqzviJnF2ush14TiI,668
+cl_forge/verify.pyi,sha256=zlEIo7IFOxX4wuzFzI242dr8fYl3cVpXhpwnFUM77-I,3493
+cl_forge-0.1.0.dist-info/METADATA,sha256=_qYkAIjITlZtxxUqYqkzL7NwUb32qDIY4nVak_-bKDE,3063
+cl_forge-0.1.0.dist-info/WHEEL,sha256=1GO8NDKTfrlRkgVXFQ5KJDUbdgIfejZHnbKJV8XeeSw,147
+cl_forge-0.1.0.dist-info/licenses/LICENSE,sha256=0CR2XP3u-v3ExT3JHO7rSNWjD1_okpXA9vVHceeIKqk,11357
+cl_forge-0.1.0.dist-info/RECORD,,

cl_forge-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: maturin (1.11.5)
+Root-Is-Purelib: false
+Tag: cp314-cp314-manylinux_2_17_x86_64
+Tag: cp314-cp314-manylinux2014_x86_64

cl_forge-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright (c) 2026 Matías Schiaffino Tyrer
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.