Download as
Browse Code »

Commit 481ffab7ce8ac6fc252903024016a611c0096902

Authored by Arthur Esposte
Committed by Rodrigo Siqueira de Melo
1 parent d44b4bb9
Exists in master and in 79 other branches add_sisp_to_chef, add_super_archives_plugin, api_for_colab, automates_core_packing, backup_not_prod, changes_in_buttons_on_content_panel, colab_automated_login, colab_spb_plugin_recipe, colab_widgets_settings, design_validation, dev_env_minimal, disable_email_dev, fix_breadcrumbs_position, fix_categories_software_link, fix_edit_institution, fix_edit_software_with_another_license, fix_get_license_info, fix_gitlab_assets_permission, fix_list_style_inside_article, fix_list_style_on_folder_elements, fix_members_pagination, fix_merge_request_url, fix_models_translations, fix_no_license, fix_software_api, fix_software_block_migration, fix_software_communities_translations, fix_software_communities_unit_test, fix_style_create_institution_admin_panel, fix_superarchives_imports, fix_sym_links_noosfero, focus_search_field_theme, gov-user-refactoring, gov-user-refactoring-rails4, header_fix, institution_modal_on_rating, kalibro-conf-refactoring, kalibro-processor-package, lxc_settings, margin_fix, mezuro_cookbook, prezento, refactor_download_block, refactor_software_communities, refactor_software_for_sisp, register_page, release-process, release-process-v2, remove-unused-images, remove_broken_theme, remove_secondary_email_from_user, remove_sisp_buttons, removing_super_archives_email, review_message, scope2method, signals_user_noosfero, sisp_catalog_header, sisp_colab_config, sisp_dev, sisp_dev_master, sisp_simple_version, software_as_organization, software_catalog_style_fix, software_communities_html_refactor, software_infos_api, spb_minimal_env, spb_to_rails4, spec_refactor, stable-4.1, stable-4.2, stable-4.x, temp_soft_comm_refactoring, theme_header, theme_javascript_refactory, thread_dropdown, thread_page, update_search_by_categories, update_software_api, update_softwares_boxes

Add documentation about how to export data to CSV

Showing 3 changed files with 51 additions and 6 deletions   Show diff stats
Rakefile
  Diff comments   View file @481ffab
... ... @@ -122,12 +122,14 @@ task :restore => [ssh_config_file, config_file] do
122 122 sh 'ssh', '-F', ssh_config_file, 'integration', 'sudo', 'systemctl start colab'
123 123 end
124 124  
125   -task :export_data => [ssh_config_file, config_file] do
126   - # setup
127   - sh 'mkdir', '-p', 'exported_data'
128   - #social
129   - sh 'ssh', '-F', ssh_config_file, 'social', 'cd /usr/lib/noosfero/ && sudo -u noosfero RAILS_ENV=production bundle exec rake export:catalog:csv'
130   - sh 'scp', '-F', ssh_config_file, 'social:/tmp/software_catalog_csvs.tar.gz', 'exported_data/'
  125 +namespace :export_data do
  126 + task :noosfero => [ssh_config_file, config_file] do
  127 + # setup
  128 + sh 'mkdir', '-p', 'exported_data'
  129 + #social
  130 + sh 'ssh', '-F', ssh_config_file, 'social', 'cd /usr/lib/noosfero/ && sudo -u noosfero RAILS_ENV=production bundle exec rake export:catalog:csv'
  131 + sh 'scp', '-F', ssh_config_file, 'social:/tmp/software_catalog_csvs.tar.gz', 'exported_data/'
  132 + end
131 133 end
132 134  
133 135 task :bootstrap_common => 'config/local/ssh_config'
... ...
docs/export_data.rst.in 0 → 100644
  Diff comments   View file @481ffab
... ... @@ -0,0 +1,42 @@
  1 +Exportação de Dados do Catálogo para CSV
  2 +======
  3 +
  4 +Esta seção descreve como realizar a exportação dos dados do Catálogo de
  5 +Software para arquivos CSV e como obter esses arquivos. Todo o procedimento
  6 +deve ser realizado num *shell* onde o diretório atual é o repositório de
  7 +controle de versão do SPB.
  8 +
  9 +Gerando os CSV
  10 +----------------------
  11 +
  12 +Suponha que estamos realizando a exportação de dados do ambiente de produção,
  13 +chamado de ``prod``; o comando para realizar uma *exportação atualizada* é o
  14 +seguinte (note ``SPB_ENV=prod``)::
  15 +
  16 + $ rake export_data:noosfero SPB_ENV=prod
  17 +
  18 +Esta operação vai executar o script na máquina *Social* para exportar os dados
  19 +atuais do Catálogo de Software para arquivos CSVs e adicioná-los em um
  20 +``tar.gz`` chamado *software_catalog_csvs.tar.gz*. Por fim, o comando ainda irá
  21 +copiar o arquivo ``software_catalog_csvs.tar.gz`` para um subdiretório chamado
  22 +``exported_data`` na sua estação de trabalho.
  23 +
  24 +Obtendo os arquivos
  25 +---------------------------
  26 +
  27 +Ao final do procedimento de exportação de dados para CSV o arquivo
  28 +``software_catalog_csvs.tar.gz`` será copiado para dentro do subdiretório
  29 +``exported_data`` na sua estação de trabalho. Para extrair os arquivos para
  30 +fora do ``software_catalog_csvs.tar.gz``, execute o seguinte comando::
  31 +
  32 + $ tar -vzxf software_catalog_csvs.tar.gz
  33 +
  34 +Os seguintes arquivos ``*.csv`` devem ser extraídos na execução do comando
  35 +acima:
  36 +
  37 +* *softwares.csv*: Contém os dados principais dos Softwares presentes no Catálogo de Software
  38 +
  39 +* *categories.csv*: Contém a lista de Categories de Software do SPB
  40 +
  41 +* *software_categories.csv*: Contém a relação dos Softwares e suas Categorias. Este arquivo é semelhante à uma tabela de Banco de Dados Relacional N x N, onde cada linha contém o ID do Software e o ID de uma de suas Categorias.
  42 +
... ...
docs/index.rst.in
  Diff comments   View file @481ffab
... ... @@ -10,4 +10,5 @@ Software Público Brasileiro: Manual de Operação (@@SPB_ENV@@)
10 10 manutencao
11 11 backup
12 12 firewall
  13 + export_data
13 14 apoio
... ...