From e78e818246daa8564fc8d5e0655a424db16ed30a Mon Sep 17 00:00:00 2001 From: Jonas Araujo de Avila Campos Date: Thu, 22 Aug 2024 09:34:57 -0300 Subject: [PATCH 1/5] feat: :lipstick: format and improve legibility on readme file --- README.md | 69 +++++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 52 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index f984923..8da17f2 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,62 @@ -# package_name +# Template para Criação de Pacotes Python 🐍 -Description. -The package package_name is used to: - - - - +Este repositório fornece um template básico para a criação de pacotes Python. Ele é projetado para facilitar o desenvolvimento e a distribuição de seus pacotes. -## Installation +## 🚀 Começando +Siga estas instruções para configurar e usar o template. -Use the package manager [pip](https://pip.pypa.io/en/stable/) to install package_name +### 📦 Instalação +Para instalar o pacote, execute o seguinte comando: -```bash -pip install package_name +`pip install nome-do-pacote` + +### 📋 Pré-requisitos + + - Python 3.6 ou superior + - pip + +### 🔧 Estrutura do Projeto + +A estrutura básica do projeto é a seguinte: + +``` +text +package-template/ +│ +├── package_name/ +│ ├── __init__.py +│ └── module.py +│ +├── tests/ +│ └── test_module.py +│ +├── README.md +└── setup.py ``` -## Usage +## 🛠️ Como Usar + +1. Clone o repositório: `git clone https://github.com/jonasaacampos/package-template.git` +2. Navegue até o diretório do projeto: `cd package-template` +3. Instale as dependências: `pip install -r requirements.txt` +4. Execute os testes: `pytest` + +## 📜 Documentação + +### Funções e Classes -```python -from package_name.module1_name import file1_name -file1_name.my_function() ``` + minha_funcao(param1, param2): Descrição da função. + MinhaClasse: Descrição da classe. +``` + +## 🤝 Contribuições +Contribuições são bem-vindas! Sinta-se à vontade para abrir um issue ou um pull request. + +## 📄 Licença +Este projeto está licenciado sob a Licença MIT. Veja o arquivo LICENSE para mais detalhes. -## Author -My_name + ## About Me: + Uma breve descrição sobre o autor... + Meu link do github. -## License -[MIT](https://choosealicense.com/licenses/mit/) \ No newline at end of file From d6a429a78d0a4b5824ced3764940c30f6a16bdc6 Mon Sep 17 00:00:00 2001 From: Jonas Araujo de Avila Campos Date: Thu, 22 Aug 2024 09:47:59 -0300 Subject: [PATCH 2/5] feat: :sparkles: create a licence file --- LICENSE.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 LICENSE.md diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..8792e6d --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 Jonas Araujo de Avila Campos + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. From 00b87c964893dcdf8f46746d24c2b1a394a78e35 Mon Sep 17 00:00:00 2001 From: Jonas Araujo de Avila Campos Date: Thu, 22 Aug 2024 09:52:00 -0300 Subject: [PATCH 3/5] feat: insert link to licence file --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8da17f2..80c4cef 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ package-template/ Contribuições são bem-vindas! Sinta-se à vontade para abrir um issue ou um pull request. ## 📄 Licença -Este projeto está licenciado sob a Licença MIT. Veja o arquivo LICENSE para mais detalhes. +Este projeto está licenciado sob a Licença MIT. Veja o arquivo [LICENCE](LICENCE.md) para mais detalhes. ## About Me: Uma breve descrição sobre o autor... From a0a4b9cd6ca67cffa5f34a6b5f528419e763a3b2 Mon Sep 17 00:00:00 2001 From: Jonas Araujo de Avila Campos Date: Thu, 22 Aug 2024 10:00:17 -0300 Subject: [PATCH 4/5] docs: :books: changed name section --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 80c4cef..8cdcd2e 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Este repositório fornece um template básico para a criação de pacotes Python. Ele é projetado para facilitar o desenvolvimento e a distribuição de seus pacotes. -## 🚀 Começando +## 🚀 Descrição Siga estas instruções para configurar e usar o template. ### 📦 Instalação From d11fb076e69afe9753f4377c91480f5abef80369 Mon Sep 17 00:00:00 2001 From: Jonas Araujo de Avila Campos Date: Mon, 26 Aug 2024 12:35:33 -0300 Subject: [PATCH 5/5] Update README.md Chore: insert section checklist for guide publication your package --- README.md | 23 +++++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8cdcd2e..9eadb7e 100644 --- a/README.md +++ b/README.md @@ -41,15 +41,30 @@ package-template/ 3. Instale as dependências: `pip install -r requirements.txt` 4. Execute os testes: `pytest` -## 📜 Documentação +## Gerar os binários e publicar -### Funções e Classes +### Para gerar os binários ``` - minha_funcao(param1, param2): Descrição da função. - MinhaClasse: Descrição da classe. +python -m pip install --upgrade pip +python -m pip install twine +python -m pip install setuptools +python -m pip install wheel + +# criar uma source distribution e uma distribuição binária +python setup.py sdist bdist_wheel ``` +## CheckList para publicação + + - [ ] Criar conta no [Test Pypi](https://test.pypi.org/account/register/) + - [ ] Publicar no Test Pypi + - [ ] Instalar pacote usando Test Pypi + - [ ] Testar pacote + - [ ] Criar conta no [Pypi](https://pypi.org/account/register/) + - [ ] Publicar no Pypi + - [ ] Instalar pacote usando Pypi + ## 🤝 Contribuições Contribuições são bem-vindas! Sinta-se à vontade para abrir um issue ou um pull request.