Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/josef-friedrich/python-boilerplate

A collection of boilerplate files and templates for my Python projects
https://github.com/josef-friedrich/python-boilerplate

Last synced: 23 days ago
JSON representation

A collection of boilerplate files and templates for my Python projects

Host: GitHub
URL: https://github.com/josef-friedrich/python-boilerplate
Owner: Josef-Friedrich
License: mit
Created: 2022-07-13T10:06:14.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-11-09T10:06:36.000Z (about 1 month ago)
Last Synced: 2024-11-09T11:18:16.118Z (about 1 month ago)
Language: Python
Homepage: https://josef-friedrich.github.io/python-project-boilerplate/
Size: 3.26 MB
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        .. image:: http://img.shields.io/pypi/v/python-boilerplate.svg

    :target: https://pypi.org/project/python-boilerplate

    :alt: This package on the Python Package Index

.. image:: https://github.com/Josef-Friedrich/python-boilerplate/actions/workflows/tests.yml/badge.svg

    :target: https://github.com/Josef-Friedrich/python-boilerplate/actions/workflows/tests.yml

    :alt: Tests

python_boilerplate

==================

A collection of boilerplate files and templates for my Python projects.

Maybe we should use:

https://github.com/cookiecutter/cookiecutter

Poetry

------

ansible-playbook playbook/all/p/poetry.yml

~/.config/pypoetry/config.toml

.. code-block:: toml

    virtualenvs.in-project = true

Ruff

----

pipx install ruff

https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff

Version

-------

``poetry version ``

https://python-poetry.org/docs/cli/#version

.. code-block:: python

    from importlib import metadata

    __version__ = metadata.version('python_boilerplate')

bump2version

^^^^^^^^^^^^

``.bumpversion.cfg```

.. code-block:: ini

    [bumpversion]

    commit = True

    tag = True

    current_version = 0.1.0

    [bumpversion:file:pyproject.toml]

    search = version = "{current_version}"

    replace = version = "{new_version}"

    [bumpversion:file:python_boilerplate/__init__.py]

    search = __version__ = '{current_version}'

    replace = __version__ = '{new_version}'

Test

----

Place the test files in a folder named ``tests``. ``poetry new``

creates a so called folder. Most projects use this named for the

test folder.

pytest

^^^^^^

Convert unittests to pytest using `pytestify `_.

littlefoxteam.vscode-python-test-adapter

pyright

^^^^^^^

.. code-block:: toml

    [tool.pyright]

    reportPrivateUsage = false

    reportPrivateUsage = false

    reportUnusedExpression = false

    reportInvalidStringEscapeSequence = false

pyenv

^^^^^

::

    pyenv-enable.sh

    pyenv update

    pyenv install --list | grep " 3."

    pyenv install 3.8.13

    pyenv install 3.9.13

    pyenv install 3.11.0b4

    pyenv local 3.8.13 3.9.13 3.11.0b4

    pip install tox tox-pyenv

    tox

    pyenv-disable.sh

Run a single test

::

    tox -e quick -- -s test test_job.TestJobWithConfigParser.test_source

Publish

-------

Publish to PyPI

.. code-block:: shell

    # https://pypi.org/manage/account/token/

    poetry config pypi-token.pypi pypi-waS5vcmcCJ...

    poetry build

    poetry publish

rst

---

Link: `Python `_.

https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#sections

1. ``#`` with overline, for parts

2. ``*`` with overline, for chapters

3. ``=`` for sections

4. ``-`` for subsections

5. ``^`` for subsubsections

6. ``"`` for paragraphs

A Literal Block::

    LITERAL BLOCK

We don’t use parts and chapters in the README files.

.. code-block:: restructuredtext

    section

    =======

    subsection

    ----------

    subsubsection

    ^^^^^^^^^^^^^

    paragraphs

    """"""""""

Include an image from an URL:

.. code-block:: restructuredtext

    .. image:: https://raw.githubusercontent.com/Josef-Friedrich/phrydy/refs/heads/main/docs/Type-hints.gif

        :alt: Type-hints.gif

Type hints

----------

mypy

^^^^

`Mypy `_ is an optional static type checker for Python.

Visual Studio Code extensions: `matangover.mypy `_

.. code-block:: toml

    [tool.mypy]

    strict = true

To avoid circular imports

.. code-block:: python

    from typing import TYPE_CHECKING

    if TYPE_CHECKING:

        from . import Process

TypedDict

^^^^^^^^^

.. code-block:: python

    from typing_extensions import TypedDict, Required, NotRequired

    class _trending(TypedDict):

        allStores: NotRequired[bool]

        category: str

        date: str

        average: List[int]

Support for typed **kwargs

^^^^^^^^^^^^^^^^^^^^^^^^^^

https://docs.python.org/3/library/typing.html#typing.Unpack

.. code-block:: python

    from typing_extensions import Unpack, TypedDict

    class MyKwargs(TypedDict, total=False):

      foo: str

      bar: int

    def baz(**kwargs: Unpack[MyKwargs]) -> None:

      pass

    baz(foo="str", bar=3) # Pylance will affirm these types.

Task runner

-----------

https://github.com/illBeRoy/taskipy

https://github.com/nat-n/poethepoet

Docs

----

Docstring formats: https://stackoverflow.com/a/24385103

use reST

Format and convert Python docstrings and generates patches: `pyment `_

Github pages

------------

`Settings / Pages `_

Source: Deploy from branch

branch: gh-pages

`Deploying a subfolder to GitHub Pages `_

Use subtree push to send it to the gh-pages branch on GitHub.

.. code-block:: shell

    touch docs/_build/.nojekyll

    git subtree push --prefix docs/_build origin gh-pages

Stub packages

-------------

    stubgen .venv/lib/python3.10/site-packages/capturer

https://peps.python.org/pep-0561/#stub-only-packages

* https://github.com/lxml/lxml-stubs

* https://github.com/tk0miya/docutils-stubs

* https://github.com/Josef-Friedrich/icinga2apic-stubs

* https://github.com/Josef-Friedrich/nagiosplugin-stubs

Add packages section to pyproject.toml

.. code-block:: toml

    [tool.poetry]

    name = "icinga2apic-stubs"

    version = "0.1.0"

    description = "Type stubs for the icinga2apic package."

    authors = ["Josef Friedrich "]

    readme = "README.rst"

    repository = "https://github.com/Josef-Friedrich/icinga2apic-stubs"

    license = "MIT"

    packages = [

        {include = "icinga2apic-stubs"}

    ]

    classifiers = [

        "License :: OSI Approved :: MIT License",

    ]

    [tool.poetry.dependencies]

    python = "^3.8"

cli

---

* argparse

* click

cli autcompletion

-----------------

* https://pypi.org/project/shtab

* https://pypi.org/project/argcomplete

* https://github.com/dan1994/pyzshcomplete (no update since 3 years)

* click