🐛 fix(Core-and-Client): general review and minor corrections

.github/workflows/Relase.yml

@@ -1,9 +1,9 @@
-name: Bump version
+name: Relase
 
 on:
   push:
     branches:
-      - master
+      - main
 
 jobs:
   bump-version:
@@ -14,17 +14,17 @@ jobs:
       - name: Check out
         uses: actions/checkout@v3
         with:
-          token: "${{ secrets.PERSONAL_ACCESS_TOKEN }}"
           fetch-depth: 0
+          token: "${{ secrets.PERSONAL_ACCESS_TOKEN }}"
       - name: Create bump and changelog
         uses: commitizen-tools/commitizen-action@master
         with:
           github_token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
-
+          changelog_increment_filename: chagelog.md
       - name: Release
         uses: softprops/action-gh-release@v1
         with:
-          body_path: "body.md"
+          body_path: "chagelog.md"
           tag_name: ${{ env.REVISION }}
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -14,9 +14,10 @@
 
 ## Índice
 * [Netbox Client](#netbox-client)
-* [Índice](#Índice)
 * [📄Dependências](#Dependências)
 * [🔧Instalação](#Instalação)
+* [🚀 Getting Started](https://netboxcli.readthedocs.io/pt/latest/Getting%20started/)
+* [📝Documentação](https://netboxcli.readthedocs.io/pt/latest/)
 * [⚙️Uso](#uso)
 * [📦Desenvolvimento](#Desenvolvimento)
 * [📌Versão](#Versão)
@@ -29,25 +30,16 @@
 ## 📄 Dependências 
   Lista as dependencias
   * requests
-  * python 3.11 ou superior
+  * python 3.12 ou superior
   * [netbox >=3.7.5](https://github.com/netbox-community/netbox)
-
-## 🔧Instalação
-
-### 📁 Acesso ao projeto
-
-Apresentar formas de baixar seu projeto.
 
-[PiP](https://pypi.org/project/netboxcli/)
+## 🔧 Instalação
 
-[Baixar projeto](https://github.com/Kaioguilherme1/netbox-client/archive/refs/heads/main.zip)
-#### Baixar o pacote via terminal.
 ```
 pip install netboxcli
 ```
-## ⚙️ Uso
 
-O NetboxCli é uma ferramenta poderosa para interagir com o NetBox de maneira simples e eficiente. Ele oferece classes consistentes com métodos padronizados para lidar com diversas funcionalidades, incluindo IPAM e Virtualização. Você pode navegar entre as classes da mesma forma que nas abas do NetBox. Aqui estão os passos básicos para começar a usar o NetboxCli:
+## ⚙️ uso
 
 ### Importando o Módulo e Preparando a Conexão
 
@@ -111,15 +103,13 @@ updated_ip_block = nb_client.ipam.prefixes.update(updated_ip_block_data)
 deleted_vm_id = nb_client.virtualization.virtual_machines.delete(id=1)
 
 ```
+para mais exemplos de uso acesse a [documentação](https://netboxcli.readthedocs.io/pt/latest/Getting%20started/)
 
 ### Personalizando e Extendendo
 
 Além das operações básicas, você pode personalizar e estender as funcionalidades do NetboxCli de acordo com suas necessidades específicas. As classes finais oferecem uma base sólida para construir interações mais avançadas com a API do NetBox.
 
 Lembre-se de substituir os exemplos de dados e IDs pelos valores reais correspondentes ao seu ambiente NetBox.
-## 📦 Desenvolvimento
-
-Nesta seção, você encontrará informações sobre o desenvolvimento contínuo do NetboxCli. Estamos trabalhando para expandir as funcionalidades e fornecer suporte abrangente para todas as abas disponíveis no NetBox 3.5 e versões posteriores. Atualizações e novas funcionalidades serão lançadas com o tempo, conforme o projeto evolui.
 
 ### Objetivo
 
@@ -147,12 +137,13 @@ Aqui está um checklist do que está atualmente disponível no NetboxCli e do qu
 Este checklist será atualizado à medida que novas funcionalidades forem implementadas. 
 Agradecemos por seu interesse e paciência enquanto trabalhamos para tornar o NetboxCli mais abrangente e útil para suas necessidades de automação e gerenciamento de rede.
 
-## 📌 Versão 1.2.0
+## 📌 Versão 1.1.5
+
+### **Adições na Versão 1.1.5**
 
-### **Adições na Versão 1.2.0**
+- **Correções de Bugs: ** Correção de bugs menores e melhorias de desempenho em todo o código.
+- **Melhorias de Desempenho: ** Otimização de consultas e operações para melhorar o desempenho geral do NetboxCli.
 
-- **Atualização do Documetação:** Atualização da documentação usando docstrings.
-- **Adicionando CI no repositorio com github Actions:** Adicionando CI no repositorio com github Actions.
 ## ✒️ Autores
 
 * **developer** - *Initial Work* - [Kaio Guilherme](https://github.com/Kaioguilherme1)

compile/api_structure.py

@@ -18,8 +18,8 @@ def create(self, data) -> dict:
         Create a new resource in {subclass} using the provided data.
         
         Args:
-            data (dict): Data to create the resource. It should contain all the necessary information to create the resource.
-        
+            data (list or dict): Data it can be a dictionary or a list of dictionaries containing the information to create the resource.
+            
         Examples:
             Create a new client:
             >>> from netboxcli import Client
@@ -79,20 +79,20 @@ def get(
         return self._core.get(id, name, tags, search, limit)
     ''',
     'PUT': '''
-    def update(self, data) -> dict:
+    def update(self, data: list) -> dict:
         """
         Update an existing resource in {subclass} with the provided data.
         
         Args:
-            data (dict): Updated data for the resource. It should contain id and optional fields to update, to default fields find in https://demo.netbox.dev/api/ .
-        
+            data (list): List of dictionaries containing the updated data for the resources.
+            
         Examples:
             Create a new client:
             >>> from netboxcli import Client
             >>> nb = Client('http://localhost:8000', 'token')
             
             Update a resource by ID:
-            >>> data = {{'id': 1, 'name': 'new_name'}}
+            >>> data = [{{'id': 1, 'name': 'new_name'}}]
             >>> result = nb.{class_main}.{subclass}.update(data)
         """
         return self._core.update(data)

compile/compile.py

@@ -1,5 +1,6 @@
 import json
 import os
+import sys
 
 from api_structure import class_header, metods
 
@@ -51,7 +52,7 @@ def code():
 
 
 def docs():
-    root_path = '../docs/api'
+    root_path = '../docs/client'
     api = read_specs()
     for folder in api:
         folder_name = folder['Class_name']
@@ -77,8 +78,7 @@ def docs():
                 file.write(content)
 
 
-def __main__():
-    import sys
+def main():
 
     if len(sys.argv) > 1:
         if sys.argv[1] == 'docs':
@@ -89,3 +89,7 @@ def __main__():
             print('Invalid argument.')
     else:
         print('No argument provided.')
+
+
+if __name__ == '__main__':
+    main()