{ "info": { "author": "Vinicius K. Ruoso", "author_email": "vinicius.ruoso@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Web Environment", "Intended Audience :: Developers", "Intended Audience :: End Users/Desktop", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python", "Topic :: Software Development :: Build Tools", "Topic :: Software Development :: Libraries :: Python Modules", "Topic :: Utilities" ], "description": "receita-tools\n=============\n\n|pypi| |travis| |license|\n\n**Idiomas do README:** |ptbr| |en|\n\nUm conjunto de ferramentas para permitir a automatiza\u00e7\u00e3o das informa\u00e7\u00f5es\ndas empresas do Brasil do site da Receita Federal Brasileira. Este conjunto\nde ferramentas utiliza o webservice\n`receitaws.com.br `_ para recuperar as informa\u00e7\u00f5es\ndas empresas que deseja.\n\n.. contents::\n :local:\n\n.. |pypi| image:: https://img.shields.io/pypi/v/receita-tools.svg?style=flat-square\n :target: https://pypi.python.org/pypi/receita-tools\n\n.. |travis| image:: https://img.shields.io/travis/vkruoso/receita-tools.svg?style=flat-square\n :target: https://travis-ci.org/vkruoso/receita-tools\n :alt: Build Status\n\n.. |license| image:: https://img.shields.io/dub/l/vibe-d.svg?style=flat-square\n\n.. |ptbr| image:: https://lipis.github.io/flag-icon-css/flags/4x3/br.svg\n :target: https://github.com/vkruoso/receita-tools/blob/master/README.rst\n :height: 20px\n\n.. |en| image:: https://lipis.github.io/flag-icon-css/flags/4x3/us.svg\n :target: https://github.com/vkruoso/receita-tools/blob/master/README.en.rst\n :height: 20px\n\nInstala\u00e7\u00e3o\n----------\n\nPara instalar as ferramentas a maneira mais f\u00e1cil \u00e9 utilizar o ``pip``::\n\n pip install receita-tools\n\n\nFerramentas para trabalhar com os dados da Receita\n--------------------------------------------------\n\nEste conjunto de ferramentas ir\u00e1 permitir recuperar informa\u00e7\u00f5es de empresas\ndo site da Receita de uma forma simples. \u00c9 poss\u00edvel recuperar informa\u00e7\u00f5es\nde v\u00e1rias empresas ao mesmo tempo. A ferramenta permite que arquivos CSV\nseja criados a partir dos dados das empresas facilitando sua importa\u00e7\u00e3o\npara o seu sistema.\n\nO Webservice\n++++++++++++\n\nOs comandos dispon\u00edveis utilizam o webservice **ReceitaWS**. Aqui est\u00e3o\nalguns links importantes sobre como o sistema funciona para leitura antes\nde iniciar a utiliza\u00e7\u00e3o:\n\n* `Documenta\u00e7\u00e3o da API`_\n* `FAQ`_\n* `Pre\u00e7os`_\n\n.. _Documenta\u00e7\u00e3o da API: https://www.receitaws.com.br/api\n.. _FAQ: https://www.receitaws.com.br/faq\n.. _Pre\u00e7os: https://www.receitaws.com.br/pricing\n\nO comando ``get``\n+++++++++++++++++\n\nO progrma de recupera\u00e7\u00e3o dos dados funciona com base em um arquivo CSV\ncontendo informa\u00e7\u00f5es sobre os CNPJs que devem ser consultados. Este arquivo\ndeve ter ao menos uma coluna, e a primeira deve ser aquela que cont\u00e9m os CNPJs\ndas empresas que deseja as informa\u00e7\u00f5es.\n\nUtiliza o comando ``receita get cnpj.csv`` para iniciar as consultas baseado\nneste aquivo CSV. Por padr\u00e3o os dados recuperados ser\u00e3o salvos no diret\u00f3rio\n``data`` relativo ao diret\u00f3rio de onde o comando foi executado. \u00c9 poss\u00edvel\nalterar o diret\u00f3rio de sa\u00edda utilizando a o\u00e7\u00e3o ``--output``. \u00c9 poss\u00edvel\nespecificar diret\u00f3rios absolutos ou relativos.\n\nExistem duas APIs para consulta, sendo uma P\u00fablica e outra Comercial. Abaixo\ndescrevemos como utilizar cada uma delas.\n\nAPI P\u00fablica\n***********\n\nPor padr\u00e3o o comando ``get`` utiliza a API P\u00fablica para recuperar as\ninforma\u00e7\u00f5es sobre as empresas. N\u00e3o \u00e9 necess\u00e1rio fazer nenhuma outra\nconfigura\u00e7\u00e3o, ent\u00e3o voc\u00ea est\u00e1 pronto para utilizar o comando. Por exemplo,\npara recuperar dados das empresas listadas no arquivo ``list.csv`` e salvar\nos resultados no diret\u00f3rio ``cnpj_data`` usando a API P\u00fablica::\n\n receita get list.csv --output cnpj_data\n\nAPI Comercial\n*************\n\nPara usar a API comercial \u00e9 preciso prover duas informa\u00e7\u00f5es extras: a\nquantidade m\u00e1xima de deprecia\u00e7\u00e3o dos dados retornados (em dias) e o token\nde acesso \u00e0 API. Voc\u00ea pode gerar este token acessando seu painel de controle\nno site ReceitaWS.\n\nAssim que voc\u00ea tiver esta informa\u00e7\u00f5es, \u00e9 preciso prover o seu token como\na vari\u00e1vel de ambiente ``RWS_TOKEN``. O par\u00e2metro de deprecia\u00e7\u00e3o precisa ser\nindicado usando a op\u00e7\u00e3o ``-d``.\n\nPara setar a vari\u00e1vel de ambiente voc\u00ea pode usar o comando ``export`` ou\nsimplesmente definir a vari\u00e1vel ao executar o comando. Este \u00e9 um exemplo\nutilizando o comando ``export`` e uma toler\u00e2ncia de 20 dias::\n\n export RWS_TOKEN=\"\"\n receita get list.csv --output cnpj_data -d 20\n\nO comando ``build``\n+++++++++++++++++++\n\nAp\u00f3s utilizar o comando ``get`` os dados das empresas ter\u00e3o sido salvos\nno sistema de arquivos local. O commando ``build`` \u00e9 usado para ler estes\ndados e gerar arquivos CSV consolidados com esta informa\u00e7\u00e3o.\n\nSe voc\u00ea n\u00e3o utilizou o diret\u00f3rio de sa\u00edda padr\u00e3o para salvar os dados,\n\u00e9 preciso inform\u00e1-lo agora. Tamb\u00e9m \u00e9 poss\u00edvel informar o diret\u00f3rio\nonde os arquivos gerados ser\u00e3o salvos.\n\n.. code::\n\n receita build --input cnpj_data --output results\n\nEste comando ir\u00e1 gerar tr\u00eas arquivos no diret\u00f3rio de sa\u00edda:\n\n* **companies.csv**: dados das empresas salvas;\n* **activities.csv**: lista das atividades das empresas (prim\u00e1rias/secund\u00e1rias);\n* **activities_seen.csv**: todas as atividades destas empresas.\n\nObtendo Ajuda\n+++++++++++++\n\n\u00c9 poss\u00edvel utilizar a op\u00e7\u00e3o ``--help`` para obter ajuda sobre um comando.\nVoc\u00ea tamb\u00e9m pode utiliz\u00e1-lo com os subcomandos, como ``receita build --help``.\n\n\nChangelog\n---------\n\n2.2.0\n+++++\n\n* `#17`_: Corrigido bug de atividades com mesmo c\u00f3digo\n* `#15`_: Adicionado suporte ao QSA\n\n2.1.1\n+++++\n\n* `#13`_: Melhorias de documenta\u00e7\u00e3o\n* `#10`_: Adicionado suporte \u00e0 `API Comercial `_ do ReceitaWS\n* `#9`_ / `#12`_: Reduzido o uso de mem\u00f3ria durante o uso de muitas empresas\n* `#5`_ / `#11`_: Adicionado suporte a JSONP na API\n* `#3`_: Adicionado no arquivos de sa\u00edda: todas as atividades\n\n2.0.3\n+++++\n\n* `#2`_: Corrigido erro quando dados inv\u00e1lidos de empresa s\u00e3o recebidos\n\n2.0.2\n+++++\n\n* Primeira release oficial do pacote *receita-tools*.\n\n1.0.0\n+++++\n\n* Uma release em PHP que realiza o trabalho do webservice. Depreciado.\n\n.. _#2: https://github.com/vkruoso/receita-tools/issues/2\n.. _#3: https://github.com/vkruoso/receita-tools/issues/3\n.. _#5: https://github.com/vkruoso/receita-tools/issues/5\n.. _#9: https://github.com/vkruoso/receita-tools/issues/9\n.. _#10: https://github.com/vkruoso/receita-tools/issues/10\n.. _#11: https://github.com/vkruoso/receita-tools/issues/11\n.. _#12: https://github.com/vkruoso/receita-tools/issues/12\n.. _#13: https://github.com/vkruoso/receita-tools/issues/13", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://github.com/vkruoso/receita-tools", "keywords": null, "license": "MIT License", "maintainer": null, "maintainer_email": null, "name": "receita-tools", "package_url": "https://pypi.org/project/receita-tools/", "platform": "any", "project_url": "https://pypi.org/project/receita-tools/", "project_urls": { "Download": "UNKNOWN", "Homepage": "http://github.com/vkruoso/receita-tools" }, "release_url": "https://pypi.org/project/receita-tools/2.2.0/", "requires_dist": null, "requires_python": null, "summary": "Tools to manipulate Receita's company data.", "version": "2.2.0" }, "last_serial": 2620330, "releases": { "2.0.0": [ { "comment_text": "", "digests": { "md5": "86fade2b6d45a19772f41a46cb513c78", "sha256": "bdfff465346827742de5a5ed467153993910e481e64bf9a7f6aae8e549828df3" }, "downloads": -1, "filename": "receita-tools-2.0.0.tar.gz", "has_sig": false, "md5_digest": "86fade2b6d45a19772f41a46cb513c78", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4368, "upload_time": "2015-07-18T23:56:04", "url": "https://files.pythonhosted.org/packages/e4/2a/2cc7ea1fdbf6bfd2a5b3e121fbb7b96b06ab9c49c643341906768a4e5306/receita-tools-2.0.0.tar.gz" } ], "2.0.1": [ { "comment_text": "", "digests": { "md5": "f7cb15c45794422c04b52f01eef78f76", "sha256": "e75a18fdef7bbce56247e4e7702aedeae1318ac5f25780bbd193d28024f97dec" }, "downloads": -1, "filename": "receita-tools-2.0.1.tar.gz", "has_sig": false, "md5_digest": "f7cb15c45794422c04b52f01eef78f76", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6261, "upload_time": "2015-07-19T03:35:47", "url": "https://files.pythonhosted.org/packages/cb/25/29cdab600a6ccec3ac02ffff9000e2f6c49d79434e96280803dfc83bf1cd/receita-tools-2.0.1.tar.gz" } ], "2.0.2": [ { "comment_text": "", "digests": { "md5": "a8b5e3da791a1b7d6934c0c20e280ea6", "sha256": "9dafb3db8bc6b8eadcffba6101c98693549f5a7a6077fafc89051341e7c75390" }, "downloads": -1, "filename": "receita-tools-2.0.2.tar.gz", "has_sig": false, "md5_digest": "a8b5e3da791a1b7d6934c0c20e280ea6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6467, "upload_time": "2015-07-19T04:18:23", "url": "https://files.pythonhosted.org/packages/3d/8e/5c8b353715afc1bed4d8abdbc5e8c469ab2b42a13246ae05ade8b8ec882a/receita-tools-2.0.2.tar.gz" } ], "2.0.3": [ { "comment_text": "", "digests": { "md5": "543dea060c56bca4e5a7196d2a410324", "sha256": "8e87038bc9a765f448a5ccbcfd4ae1dd3a21c3b8ddbf7d192f0c09c1c0a34bbf" }, "downloads": -1, "filename": "receita-tools-2.0.3.tar.gz", "has_sig": false, "md5_digest": "543dea060c56bca4e5a7196d2a410324", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6605, "upload_time": "2015-07-28T00:12:35", "url": "https://files.pythonhosted.org/packages/3b/52/207239c506b36fbcc8a6823070c250ea85c66d3c6628fe034394b2d600e1/receita-tools-2.0.3.tar.gz" } ], "2.1.0": [], "2.1.1": [ { "comment_text": "", "digests": { "md5": "39ccf1e7ebfa549b230834d93b8fe3ea", "sha256": "9a01c1645b6866ae85aabdf0ac9f79a5c131a7b090e11e74edc747e7bed64827" }, "downloads": -1, "filename": "receita-tools-2.1.1.tar.gz", "has_sig": false, "md5_digest": "39ccf1e7ebfa549b230834d93b8fe3ea", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9469, "upload_time": "2016-10-13T00:24:55", "url": "https://files.pythonhosted.org/packages/87/cb/122e3b8e8ad881408e237c3b5f54984c42fdcfdd9a98a22a114c8392e885/receita-tools-2.1.1.tar.gz" } ], "2.2.0": [ { "comment_text": "", "digests": { "md5": "fc4961759354d68b102c2237989ce9e9", "sha256": "fa3ece281a49212269a7e6d486ad8415f1e6b176daf01d9a1ec7c36b0296259e" }, "downloads": -1, "filename": "receita-tools-2.2.0.tar.gz", "has_sig": false, "md5_digest": "fc4961759354d68b102c2237989ce9e9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9628, "upload_time": "2017-02-05T11:19:12", "url": "https://files.pythonhosted.org/packages/26/b1/38bf066a23ac9f97525f3abc0ee317d00002ecaacf219c1a52bdd527edb7/receita-tools-2.2.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "fc4961759354d68b102c2237989ce9e9", "sha256": "fa3ece281a49212269a7e6d486ad8415f1e6b176daf01d9a1ec7c36b0296259e" }, "downloads": -1, "filename": "receita-tools-2.2.0.tar.gz", "has_sig": false, "md5_digest": "fc4961759354d68b102c2237989ce9e9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9628, "upload_time": "2017-02-05T11:19:12", "url": "https://files.pythonhosted.org/packages/26/b1/38bf066a23ac9f97525f3abc0ee317d00002ecaacf219c1a52bdd527edb7/receita-tools-2.2.0.tar.gz" } ] }