boilerplates 1.1.4.dev1__tar.gz → 1.2.0.dev1__tar.gz

{boilerplates-1.1.4.dev1 → boilerplates-1.2.0.dev1}/NOTICE

@@ -1,4 +1,5 @@
 Copyright (c) 2023-2025 Mateusz Bysiek  https://mbdevpl.github.io/
+Copyright (c) 2025 Stian Hanssen  https://github.com/StianHanssen
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

{boilerplates-1.1.4.dev1/boilerplates.egg-info → boilerplates-1.2.0.dev1}/PKG-INFO

@@ -1,18 +1,17 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: boilerplates
-Version: 1.1.4.dev1
+Version: 1.2.0.dev1
 Summary: Various boilerplates used in almost all of my Python packages.
 Home-page: https://github.com/mbdevpl/python-boilerplates
 Download-URL: 
-Author: Mateusz Bysiek
+Author: Mateusz Bysiek, Stian Hanssen
 Author-email: mateusz.bysiek@gmail.com
 Maintainer: Mateusz Bysiek
 Maintainer-email: mateusz.bysiek@gmail.com
-License: Apache License 2.0
+License: Apache-2.0
 Keywords: git,logging,packaging,releasing
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: MacOS
 Classifier: Operating System :: Microsoft :: Windows
 Classifier: Operating System :: POSIX :: Linux
@@ -37,13 +36,13 @@ Provides-Extra: setup
 Requires-Dist: build~=1.2; extra == "setup"
 Requires-Dist: docutils~=0.20; extra == "setup"
 Requires-Dist: Pygments~=2.14; extra == "setup"
-Requires-Dist: setuptools>=70.0; extra == "setup"
+Requires-Dist: setuptools>=77.0.3; extra == "setup"
 Requires-Dist: version-query~=1.6; extra == "setup"
 Provides-Extra: packaging-tests
 Requires-Dist: build~=1.2; extra == "packaging-tests"
 Requires-Dist: docutils~=0.20; extra == "packaging-tests"
 Requires-Dist: Pygments~=2.14; extra == "packaging-tests"
-Requires-Dist: setuptools>=70.0; extra == "packaging-tests"
+Requires-Dist: setuptools>=77.0.3; extra == "packaging-tests"
 Requires-Dist: version-query~=1.6; extra == "packaging-tests"
 Requires-Dist: pip>=24.0; extra == "packaging-tests"
 Requires-Dist: wheel>=0.43; extra == "packaging-tests"
@@ -64,6 +63,7 @@ Dynamic: description-content-type
 Dynamic: home-page
 Dynamic: keywords
 Dynamic: license
+Dynamic: license-file
 Dynamic: maintainer
 Dynamic: maintainer-email
 Dynamic: provides-extra
@@ -99,7 +99,7 @@ Various boilerplates used in almost all of my Python packages.
     :alt: grade from Codacy
 
 .. image:: https://img.shields.io/github/license/mbdevpl/python-boilerplates.svg
-    :target: https://github.com/mbdevpl/python-boilerplates/blob/v1.1.4.dev1/NOTICE
+    :target: https://github.com/mbdevpl/python-boilerplates/blob/v1.2.0.dev1/NOTICE
     :alt: license
 
 This package includes boilerplates for various common tasks in Python packages, such as building
@@ -114,9 +114,9 @@ Requirements
 
 Python version 3.9 or later.
 
-Python libraries as specified in `requirements.txt <https://github.com/mbdevpl/python-boilerplates/blob/v1.1.4.dev1/requirements.txt>`_.
+Python libraries as specified in `requirements.txt <https://github.com/mbdevpl/python-boilerplates/blob/v1.2.0.dev1/requirements.txt>`_.
 
-Building and running tests additionally requires packages listed in `requirements_test.txt <https://github.com/mbdevpl/python-boilerplates/blob/v1.1.4.dev1/requirements_test.txt>`_.
+Building and running tests additionally requires packages listed in `requirements_test.txt <https://github.com/mbdevpl/python-boilerplates/blob/v1.2.0.dev1/requirements_test.txt>`_.
 
 Tested on Linux, macOS and Windows.
 
@@ -399,7 +399,7 @@ Your example ``cli.py`` file which defines your command-line interface may look
         verbosity = boilerplates.cli.get_verbosity_level(parsed_args)
         ...
 
-You can see the above example in action in the `examples.ipynb <https://github.com/mbdevpl/python-boilerplates/blob/v1.1.4.dev1/examples.ipynb>`_ notebook.
+You can see the above example in action in the `examples.ipynb <https://github.com/mbdevpl/python-boilerplates/blob/v1.2.0.dev1/examples.ipynb>`_ notebook.
 Please see the ``boilerplates.cli`` module for details of the available features.
 
 And then, an example ``__main__.py`` file may look like:

{boilerplates-1.1.4.dev1 → boilerplates-1.2.0.dev1}/boilerplates/sentry.py

@@ -20,16 +20,26 @@ _LOG = logging.getLogger(__name__)
 class Sentry:
     """Sentry configuration.
 
-    For each parameter, the value is taken from the environment variable if it is set, otherwise
-    from the class attribute if it is set.
+    For parameters 'dsn', 'release' and 'environment', the value is taken
+    from the environment variable if it is set, otherwise from the class
+    attribute if it is set.
 
     For each parameter, the name of the environment variable name is 'SENTRY_'
     followed by the parameter name in upper case.
+
+    The class attribute tags, if set, will be added to the global scope of the
+    current Sentry SDK.
     """
 
     dsn: str
+    """Sentry DSN (Data Source Name) used to identify the project in Sentry."""
+
     release: str
+    """Release version of your application."""
+
     environment: str
+    """Environment name (e.g., 'production', 'staging', 'development')."""
+
     integrations: t.List[sentry_sdk.integrations.Integration] = [
         sentry_sdk.integrations.argv.ArgvIntegration(),
         sentry_sdk.integrations.excepthook.ExcepthookIntegration(always_run=False),
@@ -40,15 +50,43 @@ class Sentry:
         sentry_sdk.integrations.stdlib.StdlibIntegration(),
         sentry_sdk.integrations.threading.ThreadingIntegration()
     ]
+    """Sentry SDK integrations to enable.
+
+    To configure integrations that are enabled by default, also add them to this list.
+    """
+
+    default_integrations: bool = True
+    """If true, enable Sentry's default integrations besides the ones set via 'integrations'."""
+
+    debug: bool = False
+    """If True, enable debug mode for the Sentry SDK."""
+
+    attach_stacktrace: bool = False
+    """If True, attach stacktraces to messages."""
+
+    shutdown_timeout: float = 2.0
+    """Time in seconds to wait for pending events to be sent before shutdown."""
+
+    send_default_pii: t.Optional[bool] = False
+    """If True, send personally identifiable information."""
 
     traces_sample_rate: float = 1.0
+    """Ratio of transactions to sample (0.0 to 1.0)."""
+
     profiles_sample_rate: float = 1.0
+    """Ratio of transactions to profile (0.0 to 1.0)."""
+
+    tags: t.Dict[str, str] = {}
+    """Tags to be added to all events."""
 
     @classmethod
     def _get_str_param(cls, param_name: str) -> t.Optional[str]:
         """Get a string parameter value by checking envvar first.
 
         Works only for 'dsn', 'release' or 'environment' parameters.
+
+        :param param_name: name of the parameter to get
+        :return: value of the parameter
         """
         assert param_name in ('dsn', 'release', 'environment'), param_name
         return os.environ.get(f'SENTRY_{param_name.upper()}', getattr(cls, param_name, None))
@@ -67,9 +105,17 @@ class Sentry:
             return
         sentry_sdk.init(
             *args, dsn=cls._get_str_param('dsn'),
-            release=cls._get_str_param('release'), environment=cls._get_str_param('environment'),
+            release=cls._get_str_param('release'),
+            environment=cls._get_str_param('environment'),
             integrations=cls.integrations,
             traces_sample_rate=cls.traces_sample_rate,
             profiles_sample_rate=cls.profiles_sample_rate,
             enable_tracing=cls.profiles_sample_rate > 0,
+            debug=cls.debug,
+            attach_stacktrace=cls.attach_stacktrace,
+            shutdown_timeout=cls.shutdown_timeout,
+            send_default_pii=cls.send_default_pii,
+            default_integrations=cls.default_integrations,
             **kwargs)
+
+        sentry_sdk.set_tags(cls.tags)

{boilerplates-1.1.4.dev1 → boilerplates-1.2.0.dev1}/boilerplates/setup.py

@@ -19,7 +19,10 @@ HERE = pathlib.Path(__file__).resolve().parent
 DEFAULT_URL = 'https://github.com/mbdevpl'
 DEFAULT_AUTHOR = 'Mateusz Bysiek'
 DEFAULT_AUTHOR_EMAIL = 'mateusz.bysiek@gmail.com'
-DEFAULT_LICENSE_STR = 'Apache License 2.0'
+DEFAULT_LICENSE_STR = 'Apache-2.0'
+DEFAULT_LICENSE_FILE_PATTENS = [
+   'CONTRIBUTORS', 'CONTRIBUTORS.*', 'LICENSE', 'LICENSE.*', 'NOTICE', 'NOTICE.*'
+]
 
 TEST_PACKAGES = [
     'test',
@@ -262,6 +265,8 @@ class Package:
     maintainer: str
     maintainer_email: str
     license_str: str = DEFAULT_LICENSE_STR
+    license_file_patterns: t.Sequence[str] = DEFAULT_LICENSE_FILE_PATTENS
+    _existing_license_file_patterns: t.Optional[t.Sequence[str]] = None
 
     classifiers: t.List[str] = []
     """List of trove classifiers for the package.
@@ -298,8 +303,6 @@ class Package:
     'console_scripts': ['script_name = package.subpackage:function']
     """
 
-    test_suite: str = 'test'
-
     @classmethod
     def try_fields(cls, *names) -> t.Optional[t.Any]:
         """Return first existing of given class field names."""
@@ -347,6 +350,21 @@ class Package:
             cls.install_requires = parse_requirements()
         if cls.python_requires is None:
             cls.python_requires = find_required_python_version(cls.classifiers)
+        cls._prepare_existing_license_file_patterns()
+
+    @classmethod
+    def _prepare_existing_license_file_patterns(cls):
+        if cls._existing_license_file_patterns is not None:
+            return
+        cls._existing_license_file_patterns = []
+        for pattern in cls.license_file_patterns:
+            results = list(pathlib.Path().resolve().glob(pattern))
+            _LOG.debug(
+                'found %i files matching pattern "%s" in current working directory',
+                len(results), pattern)
+            if len(results) == 0:
+                continue
+            cls._existing_license_file_patterns.append(pattern)
 
     @classmethod
     def setup(cls) -> None:
@@ -360,10 +378,11 @@ class Package:
             author=cls.author, author_email=cls.author_email,
             maintainer=cls.maintainer,
             maintainer_email=cls.maintainer_email,
-            license=cls.license_str, classifiers=cls.classifiers, keywords=cls.keywords,
+            license=cls.license_str, license_files=cls._existing_license_file_patterns,
+            classifiers=cls.classifiers, keywords=cls.keywords,
             packages=cls.packages, package_dir={'': cls.root_directory},
             include_package_data=True,
             package_data=cls.package_data, exclude_package_data=cls.exclude_package_data,
             install_requires=cls.install_requires, extras_require=cls.extras_require,
             python_requires=cls.python_requires,
-            entry_points=cls.entry_points, test_suite=cls.test_suite)
+            entry_points=cls.entry_points)

{boilerplates-1.1.4.dev1 → boilerplates-1.2.0.dev1/boilerplates.egg-info}/PKG-INFO

@@ -1,18 +1,17 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: boilerplates
-Version: 1.1.4.dev1
+Version: 1.2.0.dev1
 Summary: Various boilerplates used in almost all of my Python packages.
 Home-page: https://github.com/mbdevpl/python-boilerplates
 Download-URL: 
-Author: Mateusz Bysiek
+Author: Mateusz Bysiek, Stian Hanssen
 Author-email: mateusz.bysiek@gmail.com
 Maintainer: Mateusz Bysiek
 Maintainer-email: mateusz.bysiek@gmail.com
-License: Apache License 2.0
+License: Apache-2.0
 Keywords: git,logging,packaging,releasing
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: MacOS
 Classifier: Operating System :: Microsoft :: Windows
 Classifier: Operating System :: POSIX :: Linux
@@ -37,13 +36,13 @@ Provides-Extra: setup
 Requires-Dist: build~=1.2; extra == "setup"
 Requires-Dist: docutils~=0.20; extra == "setup"
 Requires-Dist: Pygments~=2.14; extra == "setup"
-Requires-Dist: setuptools>=70.0; extra == "setup"
+Requires-Dist: setuptools>=77.0.3; extra == "setup"
 Requires-Dist: version-query~=1.6; extra == "setup"
 Provides-Extra: packaging-tests
 Requires-Dist: build~=1.2; extra == "packaging-tests"
 Requires-Dist: docutils~=0.20; extra == "packaging-tests"
 Requires-Dist: Pygments~=2.14; extra == "packaging-tests"
-Requires-Dist: setuptools>=70.0; extra == "packaging-tests"
+Requires-Dist: setuptools>=77.0.3; extra == "packaging-tests"
 Requires-Dist: version-query~=1.6; extra == "packaging-tests"
 Requires-Dist: pip>=24.0; extra == "packaging-tests"
 Requires-Dist: wheel>=0.43; extra == "packaging-tests"
@@ -64,6 +63,7 @@ Dynamic: description-content-type
 Dynamic: home-page
 Dynamic: keywords
 Dynamic: license
+Dynamic: license-file
 Dynamic: maintainer
 Dynamic: maintainer-email
 Dynamic: provides-extra
@@ -99,7 +99,7 @@ Various boilerplates used in almost all of my Python packages.
     :alt: grade from Codacy
 
 .. image:: https://img.shields.io/github/license/mbdevpl/python-boilerplates.svg
-    :target: https://github.com/mbdevpl/python-boilerplates/blob/v1.1.4.dev1/NOTICE
+    :target: https://github.com/mbdevpl/python-boilerplates/blob/v1.2.0.dev1/NOTICE
     :alt: license
 
 This package includes boilerplates for various common tasks in Python packages, such as building
@@ -114,9 +114,9 @@ Requirements
 
 Python version 3.9 or later.
 
-Python libraries as specified in `requirements.txt <https://github.com/mbdevpl/python-boilerplates/blob/v1.1.4.dev1/requirements.txt>`_.
+Python libraries as specified in `requirements.txt <https://github.com/mbdevpl/python-boilerplates/blob/v1.2.0.dev1/requirements.txt>`_.
 
-Building and running tests additionally requires packages listed in `requirements_test.txt <https://github.com/mbdevpl/python-boilerplates/blob/v1.1.4.dev1/requirements_test.txt>`_.
+Building and running tests additionally requires packages listed in `requirements_test.txt <https://github.com/mbdevpl/python-boilerplates/blob/v1.2.0.dev1/requirements_test.txt>`_.
 
 Tested on Linux, macOS and Windows.
 
@@ -399,7 +399,7 @@ Your example ``cli.py`` file which defines your command-line interface may look
         verbosity = boilerplates.cli.get_verbosity_level(parsed_args)
         ...
 
-You can see the above example in action in the `examples.ipynb <https://github.com/mbdevpl/python-boilerplates/blob/v1.1.4.dev1/examples.ipynb>`_ notebook.
+You can see the above example in action in the `examples.ipynb <https://github.com/mbdevpl/python-boilerplates/blob/v1.2.0.dev1/examples.ipynb>`_ notebook.
 Please see the ``boilerplates.cli`` module for details of the available features.
 
 And then, an example ``__main__.py`` file may look like:

{boilerplates-1.1.4.dev1 → boilerplates-1.2.0.dev1}/boilerplates.egg-info/requires.txt

@@ -14,7 +14,7 @@ colorlog~=6.7
 build~=1.2
 docutils~=0.20
 Pygments~=2.14
-setuptools>=70.0
+setuptools>=77.0.3
 version-query~=1.6
 pip>=24.0
 wheel>=0.43
@@ -26,5 +26,5 @@ sentry-sdk[pure_eval]~=2.5
 build~=1.2
 docutils~=0.20
 Pygments~=2.14
-setuptools>=70.0
+setuptools>=77.0.3
 version-query~=1.6

{boilerplates-1.1.4.dev1 → boilerplates-1.2.0.dev1}/requirements_setup.txt

@@ -1,5 +1,5 @@
 build ~= 1.2
 docutils ~= 0.20
 Pygments ~= 2.14
-setuptools >= 70.0
+setuptools >= 77.0.3
 version-query ~= 1.6

{boilerplates-1.1.4.dev1 → boilerplates-1.2.0.dev1}/setup.py

@@ -41,10 +41,11 @@ class Package(boilerplates.setup.Package):
     version = VERSION
     description = 'Various boilerplates used in almost all of my Python packages.'
     url = 'https://github.com/mbdevpl/python-boilerplates'
+    author = 'Mateusz Bysiek, Stian Hanssen'
+    maintainer = 'Mateusz Bysiek'
     classifiers = [
         'Development Status :: 5 - Production/Stable',
         'Intended Audience :: Developers',
-        'License :: OSI Approved :: Apache Software License',
         'Operating System :: MacOS',
         'Operating System :: Microsoft :: Windows',
         'Operating System :: POSIX :: Linux',

{boilerplates-1.1.4.dev1 → boilerplates-1.2.0.dev1}/test/__init__.py

@@ -1,5 +1,7 @@
 """Initialization of tests of boilerplates package."""
 
+import logging
+
 import boilerplates.logging
 
 
@@ -10,3 +12,5 @@ class TestsLogging(boilerplates.logging.Logging):
 
 
 TestsLogging.configure()
+
+logging.getLogger('boilerplates.bundled_version_query').setLevel(logging.WARNING)

{boilerplates-1.1.4.dev1 → boilerplates-1.2.0.dev1}/test/test_setup.py

@@ -231,3 +231,16 @@ class PackageTests(unittest.TestCase):
         del Package.version
         with self.assertRaises(FileNotFoundError):
             Package.prepare()
+
+    def test_prepare_license_files(self):
+        # pylint: disable = protected-access
+
+        class Package(boilerplates.setup.Package):
+            name = 'package name'
+            version = '0.1.0'
+
+        self.assertIsNone(Package._existing_license_file_patterns)
+        Package.prepare()
+        self.assertIsNotNone(Package._existing_license_file_patterns)
+        assert Package._existing_license_file_patterns is not None
+        self.assertGreater(len(Package._existing_license_file_patterns), 0)