commit 04f9f1594bceb48867abc67f7ed779faddd8dc8b Author: Breno Zanato Detomini Date: Thu Nov 27 07:54:22 2025 -0300 Initial commit diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..8d649c2 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,26 @@ +root = true + +[*] +indent_style = space +indent_size = 2 +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true + +[*.py] +indent_size = 4 + +[Makefile] +indent_style = tab +tab_width = 4 + +[*.md] +trim_trailing_whitespace = false + +[*.tsv] +indent_style = tab + +[*.bat] +end_of_line = crlf + diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..36b13f1 --- /dev/null +++ b/.gitignore @@ -0,0 +1,176 @@ +# ---> Python +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# UV +# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +#uv.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/latest/usage/project/#working-with-version-control +.pdm.toml +.pdm-python +.pdm-build/ + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ + +# Ruff stuff: +.ruff_cache/ + +# PyPI configuration file +.pypirc + diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..0e95a4f --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,23 @@ +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v5.0.0 + hooks: + - id: trailing-whitespace + - id: end-of-file-fixer + - id: check-added-large-files + - id: check-toml + - repo: https://github.com/codespell-project/codespell + rev: v2.4.1 + hooks: + - id: codespell + - repo: https://github.com/commitizen-tools/commitizen + rev: v4.8.2 + hooks: + - id: commitizen + - id: commitizen-branch + stages: [pre-push] + - repo: https://github.com/gitleaks/gitleaks + rev: v8.27.0 + hooks: + - id: gitleaks + diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..84a6c17 --- /dev/null +++ b/LICENSE @@ -0,0 +1,18 @@ +MIT License + +Copyright (c) 2025 brenozd + +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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..a1a1abc --- /dev/null +++ b/README.md @@ -0,0 +1,6 @@ +# python-template + +Python Project Template + +## Running: +`python3 -m src.python_template` diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..ace5a49 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,26 @@ +[build-system] +requires = ["hatchling"] +build-backend = "hatchling.build" + +[project] +name = "python-template" +version = "0.0.0" +dynamic = ["dependencies"] + +[tool.hatch.dependencies] +path = "requirements.txt" + +[tool.hatch.build.targets.wheel] +packages = ["src/python_template"] + +[tool.hatch.build] +skip-excluded-dirs = true + +[tool.hatch.envs.dev] +python = "3.13" +dependencies = [ + "coverage[toml]", + "pytest", + "pytest-cov", + "pytest-mock", +] diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..e69de29 diff --git a/ruff.toml b/ruff.toml new file mode 100644 index 0000000..c2d533e --- /dev/null +++ b/ruff.toml @@ -0,0 +1,39 @@ +[tool.ruff] +line-length = 120 +target-version = "py312" + +select = [ + "ALL", # include all the rules, including new ones +] +ignore = [ + #### modules + "ANN", # flake8-annotations + "COM", # flake8-commas + "C90", # mccabe complexity + "DJ", # django + "EXE", # flake8-executable + "T10", # debugger + "TID", # flake8-tidy-imports + + #### specific rules + # ignore missing docs for classes, modules, methods and etc + "D100", + "D101", + "D102", + "D103", + "D104", + "D105", + "D106", + "D107", + # ignore one-line doc string + "D200", + "D205", + "D212", + "D400", + "D401", + "D415", + "E402", # module import not at top of file + "E501", # line too long + "TD002", # missing todo author + "TD003", # missing todo link +] diff --git a/src/python_template/__init__.py b/src/python_template/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/src/python_template/__main__.py b/src/python_template/__main__.py new file mode 100644 index 0000000..fd1387c --- /dev/null +++ b/src/python_template/__main__.py @@ -0,0 +1,8 @@ +import sys +from pathlib import Path + +# Add 'src/' to sys.path manually +sys.path.insert(0, str(Path(__file__).resolve().parent.parent)) +from python_template.main import main + +main() diff --git a/src/python_template/awesome_include.py b/src/python_template/awesome_include.py new file mode 100644 index 0000000..a15f846 --- /dev/null +++ b/src/python_template/awesome_include.py @@ -0,0 +1,3 @@ +class AwesomeClass: + def __init__(self): + print("This is an Awesome Class!") diff --git a/src/python_template/main.py b/src/python_template/main.py new file mode 100644 index 0000000..2e687fd --- /dev/null +++ b/src/python_template/main.py @@ -0,0 +1,10 @@ +from python_template.awesome_include import AwesomeClass + + +def main(): + print("Python Example") + AwesomeClass() + + +if __name__ == "__main__": + main()