diff --git a/README.md b/README.md index 0912af1..55c10fc 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,35 @@ -# package_name +# 📦 Modelo de Pacote Python Simples -Description. -The package package_name is used to: - - - - +Este é um exemplo de **pacote Python simples**, criado com o objetivo de servir como base para projetos futuros. Ele foi desenvolvido para praticar a estruturação de pacotes, a organização do código, a criação de funções reutilizáveis e a escrita de testes unitários. -## Installation +--- -Use the package manager [pip](https://pip.pypa.io/en/stable/) to install package_name +## ✨ Objetivo -```bash -pip install package_name -``` +- Compreender como criar um pacote Python reutilizável. +- Praticar a separação de responsabilidades em arquivos diferentes. +- Aprender a estruturar um projeto com testes e dependências. +- Treinar o uso de `setup.py` e `requirements.txt` para empacotamento e instalação. -## Usage +--- -```python -from package_name import file1_name -file1_name.my_function() -``` +## 🚀 Funcionalidades do Pacote -## Author -My_name +O pacote contém **duas funções principais**: + +### ✅ `say_hello(name: str) -> str` + +Retorna uma saudação personalizada com o nome fornecido. + + +📌 Requisitos +Python 3.8 ou superior + +Sem dependências externas + +📄 Licença +Licenciado sob a MIT License. + +👩‍💻 Autor(a) +Feito com 💻 por Siury, estudante de Análise e Desenvolvimento de Sistemas, construindo sua base em programação. -## License -[MIT](https://choosealicense.com/licenses/mit/) \ No newline at end of file diff --git a/package_name/file1_name.py b/package_name/file1_name.py deleted file mode 100644 index e69de29..0000000 diff --git a/package_name/file2_name.py b/package_name/file2_name.py deleted file mode 100644 index e69de29..0000000 diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..9787c3b --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["setuptools", "wheel"] +build-backend = "setuptools.build_meta" diff --git a/requirements.txt b/requirements.txt index e69de29..e079f8a 100644 --- a/requirements.txt +++ b/requirements.txt @@ -0,0 +1 @@ +pytest diff --git a/setup.py b/setup.py index 4b4dc95..66d2346 100644 --- a/setup.py +++ b/setup.py @@ -1,5 +1,9 @@ from setuptools import setup, find_packages +with open("README.md", "r") as f: + page_description = f.read() +from setuptools import setup, find_packages + with open("README.md", "r") as f: page_description = f.read() @@ -7,15 +11,15 @@ requirements = f.read().splitlines() setup( - name="package_name", + name="'simple_package'", version="0.0.1", author="my_name", author_email="my_email", description="My short description", long_description=page_description, long_description_content_type="text/markdown", - url="my_github_repository_project_link" + url="my_github_repository_project_link", packages=find_packages(), install_requires=requirements, - python_requires='>=3.8', + python_requires='>=3.13.3', ) \ No newline at end of file diff --git a/simple_backage/.pypirc b/simple_backage/.pypirc new file mode 100644 index 0000000..7d65a14 --- /dev/null +++ b/simple_backage/.pypirc @@ -0,0 +1,9 @@ + +[distutils] +index-servers = + testpypi + +[testpypi] +repository = https://test.pypi.org/legacy/ +username = __token__ +password = pypi-AgENdGVzdC5weXBpLm9yZwIkZWZmODA5N2ItMzg3NS00NmJiLTkzZWItZjc3MTJlOTlmMmU2AAIqWzMsImE1ZWJhZjI1LTdhMzEtNGFhMy05ODY3LWJmMGUyMGVlMjZlYiJdAAAGIKkCQoec2VmKpc4HPf1fBJDGq7JSXr13NwSiuatmtgox diff --git a/simple_backage/__init__.py b/simple_backage/__init__.py new file mode 100644 index 0000000..8c24fad --- /dev/null +++ b/simple_backage/__init__.py @@ -0,0 +1,2 @@ +from .file1_name import say_hello +from .file2_name import add_numbers diff --git a/simple_backage/file1_name.py b/simple_backage/file1_name.py new file mode 100644 index 0000000..ae6f619 --- /dev/null +++ b/simple_backage/file1_name.py @@ -0,0 +1,2 @@ +def say_hello(name): + return f"Hello, {name}!" diff --git a/simple_backage/file2_name.py b/simple_backage/file2_name.py new file mode 100644 index 0000000..bc2226f --- /dev/null +++ b/simple_backage/file2_name.py @@ -0,0 +1,2 @@ +def add_numbers(a, b): + return a + b diff --git a/package_name/__init__.py b/test_example.py similarity index 100% rename from package_name/__init__.py rename to test_example.py diff --git a/test_script.py b/test_script.py new file mode 100644 index 0000000..dc9fc56 --- /dev/null +++ b/test_script.py @@ -0,0 +1,6 @@ +from simple_backage.file1_name import say_hello +from simple_backage.file2_name import add_numbers + +# Testando as funções +print(say_hello("Siury!")) +print(add_numbers(3, 5)) \ No newline at end of file diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..e6e3886 --- /dev/null +++ b/tox.ini @@ -0,0 +1,6 @@ +[tox] +envlist = py38, py39 + +[testenv] +deps = pytest +commands = pytest