receita-tools 2.2.0

Description:

receitatools 2.2.0

receita-tools=============|pypi| |travis| |license|**Idiomas do README:** |ptbr| |en|Um conjunto de ferramentas para permitir a automatização das informaçõesdas empresas do Brasil do site da Receita Federal Brasileira. Este conjuntode ferramentas utiliza o webservice`receitaws.com.br <http://receitaws.com.br>`_ para recuperar as informaçõesdas empresas que deseja... contents:: :local:.. |pypi| image:: https://img.shields.io/pypi/v/receita-tools.svg?style=flat-square :target: https://pypi.python.org/pypi/receita-tools.. |travis| image:: https://img.shields.io/travis/vkruoso/receita-tools.svg?style=flat-square :target: https://travis-ci.org/vkruoso/receita-tools :alt: Build Status.. |license| image:: https://img.shields.io/dub/l/vibe-d.svg?style=flat-square.. |ptbr| image:: https://lipis.github.io/flag-icon-css/flags/4x3/br.svg :target: https://github.com/vkruoso/receita-tools/blob/master/README.rst :height: 20px.. |en| image:: https://lipis.github.io/flag-icon-css/flags/4x3/us.svg :target: https://github.com/vkruoso/receita-tools/blob/master/README.en.rst :height: 20pxInstalação----------Para instalar as ferramentas a maneira mais fácil é utilizar o ``pip``:: pip install receita-toolsFerramentas para trabalhar com os dados da Receita--------------------------------------------------Este conjunto de ferramentas irá permitir recuperar informações de empresasdo site da Receita de uma forma simples. É possível recuperar informaçõesde várias empresas ao mesmo tempo. A ferramenta permite que arquivos CSVseja criados a partir dos dados das empresas facilitando sua importaçãopara o seu sistema.O Webservice++++++++++++Os comandos disponíveis utilizam o webservice **ReceitaWS**. Aqui estãoalguns links importantes sobre como o sistema funciona para leitura antesde iniciar a utilização:* `Documentação da API`_* `FAQ`_* `Preços`_.. _Documentação da API: https://www.receitaws.com.br/api.. _FAQ: https://www.receitaws.com.br/faq.. _Preços: https://www.receitaws.com.br/pricingO comando ``get``+++++++++++++++++O progrma de recuperação dos dados funciona com base em um arquivo CSVcontendo informações sobre os CNPJs que devem ser consultados. Este arquivodeve ter ao menos uma coluna, e a primeira deve ser aquela que contém os CNPJsdas empresas que deseja as informações.Utiliza o comando ``receita get cnpj.csv`` para iniciar as consultas baseadoneste aquivo CSV. Por padrão os dados recuperados serão salvos no diretório``data`` relativo ao diretório de onde o comando foi executado. É possívelalterar o diretório de saída utilizando a oção ``--output``. É possívelespecificar diretórios absolutos ou relativos.Existem duas APIs para consulta, sendo uma Pública e outra Comercial. Abaixodescrevemos como utilizar cada uma delas.API Pública***********Por padrão o comando ``get`` utiliza a API Pública para recuperar asinformações sobre as empresas. Não é necessário fazer nenhuma outraconfiguração, então você está pronto para utilizar o comando. Por exemplo,para recuperar dados das empresas listadas no arquivo ``list.csv`` e salvaros resultados no diretório ``cnpj_data`` usando a API Pública:: receita get list.csv --output cnpj_dataAPI Comercial*************Para usar a API comercial é preciso prover duas informações extras: aquantidade máxima de depreciação dos dados retornados (em dias) e o tokende acesso à API. Você pode gerar este token acessando seu painel de controleno site ReceitaWS.Assim que você tiver esta informações, é preciso prover o seu token comoa variável de ambiente ``RWS_TOKEN``. O parâmetro de depreciação precisa serindicado usando a opção ``-d``.Para setar a variável de ambiente você pode usar o comando ``export`` ousimplesmente definir a variável ao executar o comando. Este é um exemploutilizando o comando ``export`` e uma tolerância de 20 dias:: export RWS_TOKEN="<my-token>" receita get list.csv --output cnpj_data -d 20O comando ``build``+++++++++++++++++++Após utilizar o comando ``get`` os dados das empresas terão sido salvosno sistema de arquivos local. O commando ``build`` é usado para ler estesdados e gerar arquivos CSV consolidados com esta informação.Se você não utilizou o diretório de saída padrão para salvar os dados,é preciso informá-lo agora. Também é possível informar o diretórioonde os arquivos gerados serão salvos... code:: receita build --input cnpj_data --output resultsEste comando irá gerar três arquivos no diretório de saída:* **companies.csv**: dados das empresas salvas;* **activities.csv**: lista das atividades das empresas (primárias/secundárias);* **activities_seen.csv**: todas as atividades destas empresas.Obtendo Ajuda+++++++++++++É possível utilizar a opção ``--help`` para obter ajuda sobre um comando.Você também pode utilizá-lo com os subcomandos, como ``receita build --help``.Changelog---------2.2.0+++++* `#17`_: Corrigido bug de atividades com mesmo código* `#15`_: Adicionado suporte ao QSA2.1.1+++++* `#13`_: Melhorias de documentação* `#10`_: Adicionado suporte à `API Comercial <https://www.receitaws.com.br/pricing/>`_ do ReceitaWS* `#9`_ / `#12`_: Reduzido o uso de memória durante o uso de muitas empresas* `#5`_ / `#11`_: Adicionado suporte a JSONP na API* `#3`_: Adicionado no arquivos de saída: todas as atividades2.0.3+++++* `#2`_: Corrigido erro quando dados inválidos de empresa são recebidos2.0.2+++++* Primeira release oficial do pacote *receita-tools*.1.0.0+++++* Uma release em PHP que realiza o trabalho do webservice. Depreciado... _#2: https://github.com/vkruoso/receita-tools/issues/2.. _#3: https://github.com/vkruoso/receita-tools/issues/3.. _#5: https://github.com/vkruoso/receita-tools/issues/5.. _#9: https://github.com/vkruoso/receita-tools/issues/9.. _#10: https://github.com/vkruoso/receita-tools/issues/10.. _#11: https://github.com/vkruoso/receita-tools/issues/11.. _#12: https://github.com/vkruoso/receita-tools/issues/12.. _#13: https://github.com/vkruoso/receita-tools/issues/13