{
    "info": {
        "author": "Wil Filho",
        "author_email": "will@simbioseventures.com",
        "bugtrack_url": null,
        "classifiers": [
            "Programming Language :: Python :: 2.7",
            "Topic :: Scientific/Engineering :: Information Analysis",
            "Topic :: Text Processing :: Linguistic"
        ],
        "description": "# pyconclas\n[![Python version](https://img.shields.io/badge/python-v2.7-orange.svg)](https://www.python.org/downloads/)\n[![Requests version](https://img.shields.io/badge/requests-2.9.1-blue.svg)](https://pypi.python.org/pypi/requests)\n\nO pyconclas \u00e9 um client escrito em Python para utilizar o servi\u00e7o Conclas\n\n# M\u00e9todos\nAntes de mais nada, devemos importar a classe Conclas que possui os dois m\u00e9todos principais, sendo eles: o **direct_categorise()** e o **indirect_categorise()**. A classe Conclas fica dentro do m\u00f3dulo *core*. Sendo assim, vejamos o exemplo abaixo:\n\n```python\nfrom pyconclas.api import Conclas\n```\n\n## *indirect_categorise()*\nO m\u00e9todo *indirect_categorise()* faz uma requisi\u00e7\u00e3o no endpoint *categorise* da API. Ele permite que caso os conte\u00fados ainda n\u00e3o tenham sidos classificados, jogue-os diretamente em uma fila para classifica\u00e7\u00e3o.\n\n| Par\u00e2metro           | Descri\u00e7\u00e3o                                                     | Tipo | Exigido? |\n|---------------------|---------------------------------------------------------------|------|----------|\n| contents            | Passa uma lista de conte\u00fados utilizados no json da requisi\u00e7\u00e3o. | list | Sim      |\n\n## *direct_categorise()*\nO m\u00e9todo *direct_categorise()* faz uma requisi\u00e7\u00e3o no endpoint *direct_categorise* da API. Este m\u00e9todo permite que caso os conte\u00fados n\u00e3o tenham sido classficados ainda, fa\u00e7a com que esta request seja bloqueada at\u00e9 o conte\u00fado ser classificado.\n\n| Par\u00e2metro           | Descri\u00e7\u00e3o                                                       | Tipo | Exigido? |\n|---------------------|-----------------------------------------------------------------|------|----------|\n| contents            | Passa uma lista de conte\u00fados utilizados no json da requisi\u00e7\u00e3o.   | list | Sim      |\n| callback            | Passa uma url para ser chamada ap\u00f3s o t\u00e9rmino da categoriza\u00e7\u00e3o. | str  | Sim      |\n\n### Par\u00e2metro *contents*\nO par\u00e2metro *contents* \u00e9 muito importante para a requisi\u00e7\u00e3o, pois nele cont\u00e9m os dados a serem analisados pela API. Ele possui uma lista de dicion\u00e1rios, onde cada dicion\u00e1rio pode conter uma doc ou uma url mas nunca as duas no mesmo dicion\u00e1rio.\n\nA doc nada mais \u00e9 do que um dicion\u00e1rio, que poder\u00e1 receber os seguintes valores.\n\n| Par\u00e2metro  | Descri\u00e7\u00e3o                                                                             |\n|------------|---------------------------------------------------------------------------------------|\n| short_text | Corresponde a uma breve descri\u00e7\u00e3o do conte\u00fado a ser analisado. Geralmente \u00e9 o t\u00edtulo. |\n| long_text  | Corresponde ao conte\u00fado a ser analisado.                                              |\n| brands     | Corresponde a marcas que ajudam na categoriza\u00e7\u00e3o do conte\u00fado.                         |\n## Exemplo de utiliza\u00e7\u00e3o\n\n```python\nfrom pyconclas.api import Conclas\n\napi = Conclas(token=\"c6887e5fcff94746bc5f-2a931ed27123\",\n                use_ssl = False)\ncontents = [\n    {\n        \"url\": \"www.url1.com\"\n    }, \n    {\n        \"doc\": {\n            \"short_text\": \"T\u00edtulo da documento\",\n            \"long_text\": \"Conte\u00fado do p\u00e1gina\",\n            \"brands\": \"apple samsung\"\n        }\n    }\n]\n\napi.direct_categorise(contents)\nprint api.result\n```\nAp\u00f3s realizar alguma requisi\u00e7\u00e3o(seja atrav\u00e9s do m\u00e9todo direct ou indirect) o *pyconclas* popula algumas vari\u00e1veis que nos fornecem informa\u00e7\u00f5es como: headers, c\u00f3digo de status e resultado da requisi\u00e7\u00e3o. Essas propriedades s\u00e3o: **headers**, **result** e **status_code**.\n\n| Propriedade | Descri\u00e7\u00e3o                                                                            | Tipo                                          |\n|-------------|--------------------------------------------------------------------------------------|-----------------------------------------------|\n| status_code | C\u00f3digo de status da requisi\u00e7\u00e3o.(Exemplo, pode retornar 200, caso tudo tenha sido OK) | int                                           |\n| result      | Resultado da requisi\u00e7\u00e3o, geralmente vem em forma JSON.                               | str                                           |\n| headers     | Mostra os headers da requisi\u00e7\u00e3o                                                      | dict(requests.structures.CaseInsensitiveDict) |",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "UNKNOWN",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/s1mbi0se/conclas/tree/develop/conclas/clients/pyconclas",
        "keywords": "conclas machine learning pyconclas",
        "license": "BSD",
        "maintainer": null,
        "maintainer_email": null,
        "name": "pyconclas",
        "package_url": "https://pypi.org/project/pyconclas/",
        "platform": "UNKNOWN",
        "project_url": "https://pypi.org/project/pyconclas/",
        "project_urls": {
            "Download": "UNKNOWN",
            "Homepage": "https://github.com/s1mbi0se/conclas/tree/develop/conclas/clients/pyconclas"
        },
        "release_url": "https://pypi.org/project/pyconclas/0.1.2/",
        "requires_dist": null,
        "requires_python": null,
        "summary": "The pyconclas is a client written in Python to use the service Conclas.",
        "version": "0.1.2"
    },
    "last_serial": 2137297,
    "releases": {
        "0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "a8eb98617f028c6f1978e79fb9c68b1e",
                    "sha256": "5331bc1807668ce0f843518cd468de838539d23806c598f3bb773bc59f043ce0"
                },
                "downloads": -1,
                "filename": "pyconclas-0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "a8eb98617f028c6f1978e79fb9c68b1e",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 5690,
                "upload_time": "2016-05-18T22:05:20",
                "url": "https://files.pythonhosted.org/packages/17/df/1e68c0d2ebbdb2a107fb5d7e9763b2ddf4ea423e47a3a15430670eafe9e4/pyconclas-0.1.tar.gz"
            }
        ],
        "0.1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "d137f48e5bc26ae00db9a3459b8c1040",
                    "sha256": "c0fe24458f9950638116ba251d3c2020c0a2d2eb2c654b2d833c7823c39d5025"
                },
                "downloads": -1,
                "filename": "pyconclas-0.1.1.tar.gz",
                "has_sig": false,
                "md5_digest": "d137f48e5bc26ae00db9a3459b8c1040",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 5984,
                "upload_time": "2016-05-26T17:39:34",
                "url": "https://files.pythonhosted.org/packages/21/f9/e78b8db0bb2732232d799dae1dd2c407896d5bebbe1eeb972801938e4757/pyconclas-0.1.1.tar.gz"
            }
        ],
        "0.1.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "7cba7c16ebb076c3b8658b2123f44e7e",
                    "sha256": "23812f5d4685eab3dae1a9e0685f39b984a9b7fad6bac5afb6a1c1557f99ed39"
                },
                "downloads": -1,
                "filename": "pyconclas-0.1.2.tar.gz",
                "has_sig": false,
                "md5_digest": "7cba7c16ebb076c3b8658b2123f44e7e",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6031,
                "upload_time": "2016-05-27T18:58:28",
                "url": "https://files.pythonhosted.org/packages/26/d4/8ed6fe3bf8bb073ebf6dd143d42ae084f8cc7fae08fef5b2b71d2dc74fb9/pyconclas-0.1.2.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "7cba7c16ebb076c3b8658b2123f44e7e",
                "sha256": "23812f5d4685eab3dae1a9e0685f39b984a9b7fad6bac5afb6a1c1557f99ed39"
            },
            "downloads": -1,
            "filename": "pyconclas-0.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "7cba7c16ebb076c3b8658b2123f44e7e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 6031,
            "upload_time": "2016-05-27T18:58:28",
            "url": "https://files.pythonhosted.org/packages/26/d4/8ed6fe3bf8bb073ebf6dd143d42ae084f8cc7fae08fef5b2b71d2dc74fb9/pyconclas-0.1.2.tar.gz"
        }
    ]
}