modernpackage 0.0.1.dev1__tar.gz

modernpackage-0.0.1.dev1/.gitignore

@@ -0,0 +1,160 @@
+# 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
+
+# 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/#use-with-ide
+.pdm.toml
+
+# 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/

modernpackage-0.0.1.dev1/PKG-INFO

@@ -0,0 +1,47 @@
+Metadata-Version: 2.3
+Name: modernpackage
+Version: 0.0.1.dev1
+Summary: Example package configuration using bleeding edge toolset
+Project-URL: homepage, https://github.com/albertas/modernpackage
+Author-email: Albertas Gimbutas <albertasgim@gmail.com>
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.11
+Provides-Extra: test
+Requires-Dist: deadcode; extra == 'test'
+Requires-Dist: hatch; extra == 'test'
+Requires-Dist: mypy; extra == 'test'
+Requires-Dist: pip-audit; extra == 'test'
+Requires-Dist: pytest; extra == 'test'
+Requires-Dist: pytest-cov; extra == 'test'
+Requires-Dist: ruff; extra == 'test'
+Description-Content-Type: text/markdown
+
+# package
+This package is configured using bleeding edge toolset and serves as an
+example/starting point for another new packages.
+
+## Development
+Commonly used commands for package development:
+`make check` - run unit tests and linters.
+`make fix` - format code and fix detected fixable issues.
+`make publish` - publishes current package version to pypi.org.
+`make compile` - bump and freeze dependency versions in requirements*.txt files
+`make sync` - upgrade installed dependencies in Virtual Environment (executed after `make compile`)
+
+## Toolset
+This package uses these cutting edge tools:
+- ruff - for linting and code formatting
+- mypy - for type checking
+- pip-audit - for known vulnerability detection in dependencies
+- deadcode - for unused code detection
+- pytest - for collecting and running unit tests
+- coverage - for code coverage by unit tests
+- hatch - for publishing package to pypi.org
+- uv - for Python virtual environment and dependency management
+- pyproject.toml - configuration file for all tools
+- Makefile - aliases for commonly used command line commands

modernpackage-0.0.1.dev1/README.md

@@ -0,0 +1,24 @@
+# package
+This package is configured using bleeding edge toolset and serves as an
+example/starting point for another new packages.
+
+## Development
+Commonly used commands for package development:
+`make check` - run unit tests and linters.
+`make fix` - format code and fix detected fixable issues.
+`make publish` - publishes current package version to pypi.org.
+`make compile` - bump and freeze dependency versions in requirements*.txt files
+`make sync` - upgrade installed dependencies in Virtual Environment (executed after `make compile`)
+
+## Toolset
+This package uses these cutting edge tools:
+- ruff - for linting and code formatting
+- mypy - for type checking
+- pip-audit - for known vulnerability detection in dependencies
+- deadcode - for unused code detection
+- pytest - for collecting and running unit tests
+- coverage - for code coverage by unit tests
+- hatch - for publishing package to pypi.org
+- uv - for Python virtual environment and dependency management
+- pyproject.toml - configuration file for all tools
+- Makefile - aliases for commonly used command line commands

modernpackage-0.0.1.dev1/pyproject.toml

@@ -0,0 +1,86 @@
+[project]
+name = "modernpackage"
+version = "0.0.1.dev1"
+authors = [
+    {name = "Albertas Gimbutas", email = "albertasgim@gmail.com"},
+]
+description = "Example package configuration using bleeding edge toolset"
+readme = "README.md"
+requires-python = ">= 3.11"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "License :: OSI Approved :: MIT License",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.11",
+]
+dependencies = [
+]
+
+
+[project.urls]
+homepage = "https://github.com/albertas/modernpackage"
+
+[project.optional-dependencies]
+test = [
+    "hatch",
+    "ruff",
+    "mypy",
+    "pip-audit",
+    "deadcode",
+    "pytest",
+    "pytest-cov",
+]
+
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build]
+include = ["**/*.py"]
+exclude = ["tests/**"]
+
+
+[tool.ruff]  # https://docs.astral.sh/ruff/settings/
+line-length = 88
+
+[tool.ruff.lint.flake8-quotes]
+inline-quotes = "single"
+
+[tool.ruff.format]
+quote-style = "single"
+docstring-code-format = true
+
+[tool.ruff.lint]
+select = ["ALL"]
+ignore = [
+    "D203",  # one-blank-line-before-class
+    "D213",  # multi-line-summary-second-line
+    "COM812",  # missing-trailing-comma
+    "ISC001",  # single-line-implicit-string-concatenation
+    "ANN101",  # deprecated self annotation
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = ["S101", "D"]  # allow asserts and no docs in tests
+
+[tool.mypy]
+exclude = ["build", "dist", ".venv", "tests"]
+python_version = "3.11"
+strict = true
+pretty = true
+color_output = true
+show_error_codes = true
+warn_return_any = true
+warn_unused_configs = true
+
+[tool.pytest.ini_options]
+addopts = "--cov=. --no-cov-on-fail --cov-fail-under=90.0"
+
+[tool.deadcode]
+ignore_names = [
+    "main",
+]
+exclude = ["tests"]

modernpackage-0.0.1.dev1/src/__init__.py

@@ -0,0 +1 @@
+"""Example package configuration using bleeding edge toolset."""

modernpackage-0.0.1.dev1/src/main.py

@@ -0,0 +1,6 @@
+"""Example package configuration using bleeding edge toolset."""
+
+
+def main() -> str:
+    """Return 'Hello world'."""
+    return 'Hello world'