colppy-api


Namecolppy-api JSON
Version 1.1.0 PyPI version JSON
download
home_pageNone
SummaryCliente API para Colppy (NO OFICIAL)
upload_time2025-01-31 12:56:33
maintainerNone
docs_urlNone
authorNone
requires_python>=3.11
licenseMIT
keywords api client colppy
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Colppy API Client

Cliente Python para la API de Colppy, sistema de gestión contable y financiera.

## Instalación

```bash
pip install colppy-api
```

## Configuración

El paquete incluye una CLI para facilitar la configuración inicial:

```bash
# Crear archivo de configuración interactivamente
colppy-api init
```

O puedes crear manualmente un archivo `config.json` en el directorio raíz de tu proyecto:

```json
{
  "ColppyAPI": {
    "COLPPY_API_URI": "https://login.colppy.com/lib/frontera2/service.php",
    "COLPPY_AUTH_USER": "tu_usuario",
    "COLPPY_AUTH_PASSWORD": "tu_password",
    "COLPPY_PARAMS_USER": "tu_usuario_params",
    "COLPPY_PARAMS_PASSWORD": "tu_password_params"
  },
  "LogLevel": {
    "LOG_LEVEL": "DEBUG"
  }
}
```

## Uso Básico

```python
from colppy import ColppyAPIClient

async def main():
    # Inicializar cliente
    client = ColppyAPIClient()
    await client.get_token()

    # Ejemplo: Obtener empresas
    empresas = await client.get_empresas()
    
    await client.logout()

if __name__ == "__main__":
    import asyncio
    asyncio.run(main())
```

## Funcionalidades Principales

- Gestión de empresas
- Gestión de clientes
- Gestión de proveedores
- Comprobantes de compra y venta
- Movimientos contables
- Manejo de sesiones

## Tipos de Comprobantes

| ID | Código | Descripción               |
|----|--------|---------------------------|
| 1  | FAC    | Factura de Compra        |
| 2  | NCC    | Nota de Crédito Compra   |
| 3  | NDC    | Nota de Débito Compra    |
| 4  | FAV    | Factura de Venta         |
| 5  | NCV    | Nota de Crédito Venta    |
| 6  | NDV    | Nota de Débito Venta     |
| 7  | FCC    | Factura Compra Contado   |
| 8  | FVC    | Factura Venta Contado    |

## Desarrollo

Para contribuir al desarrollo:

```bash
# Clonar repositorio
git clone https://bitbucket.org/groovinads/colppi-api.git

# Crear entorno virtual
python -m venv .venv

# Activar entorno virtual
source .venv/bin/activate  # Linux/Mac
.venv\Scripts\activate     # Windows

# Instalar en modo desarrollo
pip install -e .
```

### Scripts de Desarrollo

```bash
# Publicar en PyPI
python scripts/run.py publish

# Limpiar caché
python scripts/run.py clean-cache

# Limpiar proyecto
python scripts/run.py clean

# Ejecutar todo
python scripts/run.py all
```

### Comandos CLI

```bash
# Inicializar configuración
colppy-api init

# Ver ayuda
colppy-api --help
```

## Licencia

MIT License


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "colppy-api",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": null,
    "keywords": "api, client, colppy",
    "author": null,
    "author_email": "Groovinads <juanmanuel.panozzo@groovinads.com>",
    "download_url": "https://files.pythonhosted.org/packages/71/a1/e7a6e15dfbad7cd8126d05a4d029009a640b225fb863d9450ee8ec647fc2/colppy_api-1.1.0.tar.gz",
    "platform": null,
    "description": "# Colppy API Client\n\nCliente Python para la API de Colppy, sistema de gesti\u00f3n contable y financiera.\n\n## Instalaci\u00f3n\n\n```bash\npip install colppy-api\n```\n\n## Configuraci\u00f3n\n\nEl paquete incluye una CLI para facilitar la configuraci\u00f3n inicial:\n\n```bash\n# Crear archivo de configuraci\u00f3n interactivamente\ncolppy-api init\n```\n\nO puedes crear manualmente un archivo `config.json` en el directorio ra\u00edz de tu proyecto:\n\n```json\n{\n  \"ColppyAPI\": {\n    \"COLPPY_API_URI\": \"https://login.colppy.com/lib/frontera2/service.php\",\n    \"COLPPY_AUTH_USER\": \"tu_usuario\",\n    \"COLPPY_AUTH_PASSWORD\": \"tu_password\",\n    \"COLPPY_PARAMS_USER\": \"tu_usuario_params\",\n    \"COLPPY_PARAMS_PASSWORD\": \"tu_password_params\"\n  },\n  \"LogLevel\": {\n    \"LOG_LEVEL\": \"DEBUG\"\n  }\n}\n```\n\n## Uso B\u00e1sico\n\n```python\nfrom colppy import ColppyAPIClient\n\nasync def main():\n    # Inicializar cliente\n    client = ColppyAPIClient()\n    await client.get_token()\n\n    # Ejemplo: Obtener empresas\n    empresas = await client.get_empresas()\n    \n    await client.logout()\n\nif __name__ == \"__main__\":\n    import asyncio\n    asyncio.run(main())\n```\n\n## Funcionalidades Principales\n\n- Gesti\u00f3n de empresas\n- Gesti\u00f3n de clientes\n- Gesti\u00f3n de proveedores\n- Comprobantes de compra y venta\n- Movimientos contables\n- Manejo de sesiones\n\n## Tipos de Comprobantes\n\n| ID | C\u00f3digo | Descripci\u00f3n               |\n|----|--------|---------------------------|\n| 1  | FAC    | Factura de Compra        |\n| 2  | NCC    | Nota de Cr\u00e9dito Compra   |\n| 3  | NDC    | Nota de D\u00e9bito Compra    |\n| 4  | FAV    | Factura de Venta         |\n| 5  | NCV    | Nota de Cr\u00e9dito Venta    |\n| 6  | NDV    | Nota de D\u00e9bito Venta     |\n| 7  | FCC    | Factura Compra Contado   |\n| 8  | FVC    | Factura Venta Contado    |\n\n## Desarrollo\n\nPara contribuir al desarrollo:\n\n```bash\n# Clonar repositorio\ngit clone https://bitbucket.org/groovinads/colppi-api.git\n\n# Crear entorno virtual\npython -m venv .venv\n\n# Activar entorno virtual\nsource .venv/bin/activate  # Linux/Mac\n.venv\\Scripts\\activate     # Windows\n\n# Instalar en modo desarrollo\npip install -e .\n```\n\n### Scripts de Desarrollo\n\n```bash\n# Publicar en PyPI\npython scripts/run.py publish\n\n# Limpiar cach\u00e9\npython scripts/run.py clean-cache\n\n# Limpiar proyecto\npython scripts/run.py clean\n\n# Ejecutar todo\npython scripts/run.py all\n```\n\n### Comandos CLI\n\n```bash\n# Inicializar configuraci\u00f3n\ncolppy-api init\n\n# Ver ayuda\ncolppy-api --help\n```\n\n## Licencia\n\nMIT License\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Cliente API para Colppy (NO OFICIAL)",
    "version": "1.1.0",
    "project_urls": {
        "Homepage": "https://bitbucket.org/groovinads/colppi-api",
        "Issues": "https://bitbucket.org/groovinads/colppi-api/issues"
    },
    "split_keywords": [
        "api",
        " client",
        " colppy"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "36ee4f3c6be890a374f944871d2b4fe0dd11d8c7d584bc41001cc43c97e4435b",
                "md5": "ac72261572b15bbaea14709668c63047",
                "sha256": "e84ebce3be6d4bdda5db797e771bb117467d7b9f8fca0afc038a54e0dac9260a"
            },
            "downloads": -1,
            "filename": "colppy_api-1.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ac72261572b15bbaea14709668c63047",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 23591,
            "upload_time": "2025-01-31T12:56:32",
            "upload_time_iso_8601": "2025-01-31T12:56:32.224685Z",
            "url": "https://files.pythonhosted.org/packages/36/ee/4f3c6be890a374f944871d2b4fe0dd11d8c7d584bc41001cc43c97e4435b/colppy_api-1.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "71a1e7a6e15dfbad7cd8126d05a4d029009a640b225fb863d9450ee8ec647fc2",
                "md5": "a2f0fca6811498655d2510ea27d514dc",
                "sha256": "2fbf20689ac1fd5e450c157561e98abebea3cc3f313015d631f41a4e058d6cd9"
            },
            "downloads": -1,
            "filename": "colppy_api-1.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "a2f0fca6811498655d2510ea27d514dc",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 17939,
            "upload_time": "2025-01-31T12:56:33",
            "upload_time_iso_8601": "2025-01-31T12:56:33.452271Z",
            "url": "https://files.pythonhosted.org/packages/71/a1/e7a6e15dfbad7cd8126d05a4d029009a640b225fb863d9450ee8ec647fc2/colppy_api-1.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-31 12:56:33",
    "github": false,
    "gitlab": false,
    "bitbucket": true,
    "codeberg": false,
    "bitbucket_user": "groovinads",
    "bitbucket_project": "colppi-api",
    "lcname": "colppy-api"
}
        
Elapsed time: 0.99578s