log21 2.10.2__tar.gz → 3.0.1__tar.gz

{log21-2.10.2 → log21-3.0.1}/PKG-INFO

@@ -1,33 +1,27 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: log21
-Version: 2.10.2
-Summary: A simple logging package that helps you log colorized messages in Windows console.
-Author-email: "CodeWriter21(Mehrad Pooryoussof)" <CodeWriter21@gmail.com>
-License: Apache License 2.0
-Project-URL: Homepage, https://github.com/MPCodeWriter21/log21
-Project-URL: Donations, https://github.com/MPCodeWriter21/log21/blob/master/DONATE.md
-Project-URL: Source, https://github.com/MPCodeWriter21/log21
+Version: 3.0.1
+Summary: A simple logging package
 Keywords: python,log,colorize,color,logging,Python3,CodeWriter21
+Author: CodeWriter21(Mehrad Pooryoussof)
+Author-email: CodeWriter21(Mehrad Pooryoussof) <CodeWriter21@gmail.com>
+License: Apache License 2.0
 Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Operating System :: Unix
 Classifier: Operating System :: Microsoft :: Windows
 Classifier: Operating System :: MacOS :: MacOS X
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-License-File: LICENSE.txt
 Requires-Dist: webcolors
 Requires-Dist: docstring-parser
-Provides-Extra: dev
-Requires-Dist: yapf; extra == "dev"
-Requires-Dist: isort; extra == "dev"
-Requires-Dist: docformatter; extra == "dev"
-Requires-Dist: pylint; extra == "dev"
-Requires-Dist: json5; extra == "dev"
-Requires-Dist: pytest; extra == "dev"
+Requires-Python: >=3.9
+Project-URL: Donations, https://github.com/MPCodeWriter21/log21/blob/master/DONATE.md
+Project-URL: Homepage, https://github.com/MPCodeWriter21/log21
+Project-URL: Source, https://github.com/MPCodeWriter21/log21
+Description-Content-Type: text/markdown
 
 log21
 =====
@@ -46,15 +40,15 @@ Features
 
 + Colors : The main reason for this package was to log text in the Windows console with
   the support of ANSI colors.
-+ Argument parsing : log21's argument parser can be used like python's argparse but it
++ Argument parsing : log21's argument parser can be used like python's argparse, but it
   also colorizes the output.
 + Logging : A similar logger to logging. Logger but with colorized output and other
   options such as levelname modifications. It can also decolorize the output if you want
   to log into a file.
 + Pretty printing : Have you ever wanted to colorize the output of the pprint module?
   log21's pretty printer can do that.
-+ Tree printing : You can pass a dict or list to `log21.tree_print` function and it will
-  print it in a tree-like structure. It's also colorized XD.
++ Tree printing : You can pass a dict or list to `log21.tree_print` function, and it
+  will print it in a tree-like structure. It's also colorized XD.
 + ProgressBar : log21's progress bar can be used to show progress of a process in a
   beautiful way.
 + LoggingWindow : Helps you to log messages and debug your code in a window other than
@@ -97,12 +91,88 @@ Or let the pip get it using git:
 pip install git+https://github.com/MPCodeWriter21/log21
 ```
 
-Changes
--------
+Changelog
+---------
+
+### v3.0.1
+
+Fix the issue with `argumentify` which would result in falsy default values to be
+replaced with None.
+
++ Example:
+
+```python
+def main(offset: int = 0) -> None:
+    ...
+
+argumentify(main)
+```
+
+if no value is provided for `--offset`, the default will be `None` instead of `0` which
+is unexpected and can lead to issues.
+
+#### Breaking Changes
+
++ **Internal module renaming and normalization**
+  + All internal modules were renamed to lowercase and, in some cases, split or
+    reorganized.
+  + Imports such as `log21.Colors`, `log21.Logger`, `log21.ProgressBar`, etc. are no
+    longer valid.
+  + Users importing from internal modules must update their imports to the new module
+    names.
+  + Public imports from `log21` remain supported.
+
++ **Argumentify exception renames**
+  + Several exceptions were renamed to follow a consistent `*Error` naming convention:
+    + `TooFewArguments` → `TooFewArgumentsError`
+    + `RequiredArgument` → `RequiredArgumentError`
+    + `IncompatibleArguments` → `IncompatibleArgumentsError`
+  + Code that explicitly raises or catches these exceptions must be updated.
+
+#### Changes
+
++ **Crash reporter behavior improvement**
+  + Prevented the default file crash reporter from creating `.crash_report` files when it
+    is not actually used.
+  + Implemented using an internal `FakeModule` helper.
+
++ **Argparse compatibility update**
+  + Bundled and used the Python 3.13 `argparse` implementation to ensure consistent
+    behavior across supported Python versions.
+
++ **Progress bar module rename**
+  + Renamed the internal progress bar module to `progress_bar` for consistency with the
+    new naming scheme.
+  + This will not break the usages of `log21.progress_bar(...)` since the call
+    functionality was added to the module using the `FakeModule` helper.
+
++ **Examples added and updated**
+  + Added new example code files.
+  + Updated existing examples to match the v3 API and conventions.
+
+#### Fixes
+
++ Resolved various linting and static-analysis issues across the codebase.
++ Addressed minor compatibility issues uncovered by running linters and pre-commit hooks.
++ Resolved errors occurring in environments with newer versions of argparse.
+
+#### Internal and Maintenance Changes
+
++ Migrated the build system configuration to `uv`.
++ Updated Python version classifiers and set the supported Python version to 3.9+.
++ Added `vermin` to the pre-commit configuration.
++ Updated `.gitignore`, license metadata, and tool configurations.
++ Silenced and resolved a large number of linter warnings.
++ General internal refactoring with no intended user-visible behavioral changes.
 
-### 2.10.1
+#### Notes
 
-+ Updated the Argparse module to be usable with python 3.12.3.
++ There are **no intentional behavioral changes** in logging output, argument parsing
+  logic, or UI components.
++ Most projects will require **minimal or no changes** unless they depend on internal
+  modules or renamed exceptions.
++ See [MIGRATION-V2-V3.md](https://github.com/MPCodeWriter21/log21/blob/master/MIGRATION-V2-V3.md)
+for detailed upgrade instructions.
 
 [Full CHANGELOG](https://github.com/MPCodeWriter21/log21/blob/master/CHANGELOG.md)
 
@@ -132,7 +202,8 @@ In order to support this project you can donate some crypto of your choice 8D
 
 [Donate Addresses](https://github.com/MPCodeWriter21/log21/blob/master/DONATE.md)
 
-Or if you can't, give [this project](https://github.com/MPCodeWriter21/log21) a star on GitHub :)
+Or if you can't, give [this project](https://github.com/MPCodeWriter21/log21) a star on
+GitHub :)
 
 References
 ----------

log21-2.10.2/src/log21.egg-info/PKG-INFO → log21-3.0.1/README.md

@@ -1,34 +1,3 @@
-Metadata-Version: 2.1
-Name: log21
-Version: 2.10.2
-Summary: A simple logging package that helps you log colorized messages in Windows console.
-Author-email: "CodeWriter21(Mehrad Pooryoussof)" <CodeWriter21@gmail.com>
-License: Apache License 2.0
-Project-URL: Homepage, https://github.com/MPCodeWriter21/log21
-Project-URL: Donations, https://github.com/MPCodeWriter21/log21/blob/master/DONATE.md
-Project-URL: Source, https://github.com/MPCodeWriter21/log21
-Keywords: python,log,colorize,color,logging,Python3,CodeWriter21
-Classifier: Intended Audience :: Developers
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Operating System :: Unix
-Classifier: Operating System :: Microsoft :: Windows
-Classifier: Operating System :: MacOS :: MacOS X
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-License-File: LICENSE.txt
-Requires-Dist: webcolors
-Requires-Dist: docstring-parser
-Provides-Extra: dev
-Requires-Dist: yapf; extra == "dev"
-Requires-Dist: isort; extra == "dev"
-Requires-Dist: docformatter; extra == "dev"
-Requires-Dist: pylint; extra == "dev"
-Requires-Dist: json5; extra == "dev"
-Requires-Dist: pytest; extra == "dev"
-
 log21
 =====
 
@@ -46,15 +15,15 @@ Features
 
 + Colors : The main reason for this package was to log text in the Windows console with
   the support of ANSI colors.
-+ Argument parsing : log21's argument parser can be used like python's argparse but it
++ Argument parsing : log21's argument parser can be used like python's argparse, but it
   also colorizes the output.
 + Logging : A similar logger to logging. Logger but with colorized output and other
   options such as levelname modifications. It can also decolorize the output if you want
   to log into a file.
 + Pretty printing : Have you ever wanted to colorize the output of the pprint module?
   log21's pretty printer can do that.
-+ Tree printing : You can pass a dict or list to `log21.tree_print` function and it will
-  print it in a tree-like structure. It's also colorized XD.
++ Tree printing : You can pass a dict or list to `log21.tree_print` function, and it
+  will print it in a tree-like structure. It's also colorized XD.
 + ProgressBar : log21's progress bar can be used to show progress of a process in a
   beautiful way.
 + LoggingWindow : Helps you to log messages and debug your code in a window other than
@@ -97,12 +66,88 @@ Or let the pip get it using git:
 pip install git+https://github.com/MPCodeWriter21/log21
 ```
 
-Changes
--------
+Changelog
+---------
+
+### v3.0.1
+
+Fix the issue with `argumentify` which would result in falsy default values to be
+replaced with None.
+
++ Example:
+
+```python
+def main(offset: int = 0) -> None:
+    ...
+
+argumentify(main)
+```
+
+if no value is provided for `--offset`, the default will be `None` instead of `0` which
+is unexpected and can lead to issues.
+
+#### Breaking Changes
+
++ **Internal module renaming and normalization**
+  + All internal modules were renamed to lowercase and, in some cases, split or
+    reorganized.
+  + Imports such as `log21.Colors`, `log21.Logger`, `log21.ProgressBar`, etc. are no
+    longer valid.
+  + Users importing from internal modules must update their imports to the new module
+    names.
+  + Public imports from `log21` remain supported.
+
++ **Argumentify exception renames**
+  + Several exceptions were renamed to follow a consistent `*Error` naming convention:
+    + `TooFewArguments` → `TooFewArgumentsError`
+    + `RequiredArgument` → `RequiredArgumentError`
+    + `IncompatibleArguments` → `IncompatibleArgumentsError`
+  + Code that explicitly raises or catches these exceptions must be updated.
+
+#### Changes
+
++ **Crash reporter behavior improvement**
+  + Prevented the default file crash reporter from creating `.crash_report` files when it
+    is not actually used.
+  + Implemented using an internal `FakeModule` helper.
+
++ **Argparse compatibility update**
+  + Bundled and used the Python 3.13 `argparse` implementation to ensure consistent
+    behavior across supported Python versions.
+
++ **Progress bar module rename**
+  + Renamed the internal progress bar module to `progress_bar` for consistency with the
+    new naming scheme.
+  + This will not break the usages of `log21.progress_bar(...)` since the call
+    functionality was added to the module using the `FakeModule` helper.
+
++ **Examples added and updated**
+  + Added new example code files.
+  + Updated existing examples to match the v3 API and conventions.
+
+#### Fixes
+
++ Resolved various linting and static-analysis issues across the codebase.
++ Addressed minor compatibility issues uncovered by running linters and pre-commit hooks.
++ Resolved errors occurring in environments with newer versions of argparse.
+
+#### Internal and Maintenance Changes
+
++ Migrated the build system configuration to `uv`.
++ Updated Python version classifiers and set the supported Python version to 3.9+.
++ Added `vermin` to the pre-commit configuration.
++ Updated `.gitignore`, license metadata, and tool configurations.
++ Silenced and resolved a large number of linter warnings.
++ General internal refactoring with no intended user-visible behavioral changes.
 
-### 2.10.1
+#### Notes
 
-+ Updated the Argparse module to be usable with python 3.12.3.
++ There are **no intentional behavioral changes** in logging output, argument parsing
+  logic, or UI components.
++ Most projects will require **minimal or no changes** unless they depend on internal
+  modules or renamed exceptions.
++ See [MIGRATION-V2-V3.md](https://github.com/MPCodeWriter21/log21/blob/master/MIGRATION-V2-V3.md)
+for detailed upgrade instructions.
 
 [Full CHANGELOG](https://github.com/MPCodeWriter21/log21/blob/master/CHANGELOG.md)
 
@@ -132,7 +177,8 @@ In order to support this project you can donate some crypto of your choice 8D
 
 [Donate Addresses](https://github.com/MPCodeWriter21/log21/blob/master/DONATE.md)
 
-Or if you can't, give [this project](https://github.com/MPCodeWriter21/log21) a star on GitHub :)
+Or if you can't, give [this project](https://github.com/MPCodeWriter21/log21) a star on
+GitHub :)
 
 References
 ----------

{log21-2.10.2 → log21-3.0.1}/pyproject.toml

@@ -1,23 +1,20 @@
-[build-system]
-requires = ["setuptools>=61.0.0", "wheel"]
-build-backend = "setuptools.build_meta"
-
 [project]
 name = "log21"
 authors = [
     {name = "CodeWriter21(Mehrad Pooryoussof)", email = "CodeWriter21@gmail.com"}
 ]
-description = "A simple logging package that helps you log colorized messages in Windows console."
+description = "A simple logging package"
 readme = {file = "README.md", content-type = "text/markdown"}
-requires-python = ">=3.8"
+requires-python = ">=3.9"
 keywords = ['python', 'log', 'colorize', 'color', 'logging', 'Python3', 'CodeWriter21']
 license = {text = "Apache License 2.0"}
 classifiers = [
     "Intended Audience :: Developers",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
     "Operating System :: Unix",
     "Operating System :: Microsoft :: Windows",
     "Operating System :: MacOS :: MacOS X"
@@ -26,46 +23,41 @@ dependencies = [
     "webcolors",
     "docstring-parser"
 ]
-version = "2.10.2"
+version = "3.0.1"
 
-[tool.setuptools.packages.find]
-where = ["src"]
+[build-system]
+requires = ["uv_build>=0.8.15,<0.9.0"]
+build-backend = "uv_build"
 
 [project.urls]
 Homepage = "https://github.com/MPCodeWriter21/log21"
 Donations = "https://github.com/MPCodeWriter21/log21/blob/master/DONATE.md"
 Source = "https://github.com/MPCodeWriter21/log21"
 
-[project.optional-dependencies]
-dev = ["yapf", "isort", "docformatter", "pylint", "json5", "pytest"]
-
-[tool.pylint.messages_control]
-max-line-length = 88
-
-disable = [
-    "too-few-public-methods",
-    "too-many-arguments",
-    "protected-access",
-    "too-many-locals",
-    "fixme",
-]
-
-[tool.pylint.design]
-max-returns = 8
-
 [tool.yapf]
 column_limit = 88
 split_before_dot = true
-split_before_first_argument = true
 dedent_closing_brackets = true
+split_before_first_argument = true
 
 [tool.isort]
 line_length = 88
-combine_as_imports = true
-length_sort = true
 order_by_type = true
+length_sort = true
+combine_as_imports = true
 
 [tool.docformatter]
 recursive = true
 wrap-summaries = 88
 wrap-descriptions = 88
+
+[tool.ruff]
+show-fixes = true
+exclude = ["migrations"]
+target-version = "py39"
+line-length = 88
+
+[tool.ruff.lint]
+extend-select = ["C4", "SIM", "TCH", "PL", "ANN", "N", "B"]
+ignore = ["PLR0911", "PLR0912", "PLR0913", "PLR0914", "ANN101", "B008", "N816",
+          "ANN002", "ANN003", "ANN401", "N802", "PLR2004"]