crackerjack 0.1.10__tar.gz → 0.1.12__tar.gz

{crackerjack-0.1.10 → crackerjack-0.1.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: crackerjack
-Version: 0.1.10
+Version: 0.1.12
 Summary: Crackerjack code formatting style.
 Keywords: black ruff mypy creosote refurb
 Home-page: https://github.com/lesleslie/crackerjack
@@ -33,10 +33,13 @@ Description-Content-Type: text/markdown
 
 Crackerjack is a python coding style which uses a minimalist approach to produce elegant, easy to read, code.
 
+crack·​er·​jack ˈkra-kər-ˌjak
+: a person or thing of marked excellence
+
 ### **Why Crackerjack?**
 
-Crackerjack works on the theory that with static typing and explicit classes,
-functions, variables, and other object names - the code should be
+Crackerjack works on the theory that with static typing and explicit class,
+function, variable, and other object names - the code should be
 straight forward to read and the documentation should pretty much be able to write
 itself. Crackerjack provides a set of guidelines and utilities to keep the codebase clean, elegant, standardized, and
 easily readable.
@@ -57,15 +60,17 @@ This package:
 
 - streamlines code with refurb
 
-- converts/creates documentation in Markdown (md)
-
-- installs, or updates, a projects pre-commit tools and gitignore
+- installs, or updates, a project's pre-commit tools and gitignore
   to comply with evolving crackerjack standards
 
 - removes pipenv, poetry, and hatch build, dependency management, and virtual environment
-  management packages and replace them with PDM using PEP 582
+  management packages and replaces them with PDM using PEP 582
+
+- converts/creates documentation in Markdown (md) - Coming Soon!
 
-- generates pytest mock stubs if needed
+- runs tests and generates pytest mock stubs if needed - Coming Soon!
+
+- bumps the project version and publishes it to PyPI
 
 ### **What are the rules?**
 
@@ -112,9 +117,19 @@ From your projects root directory:
 
 Cracker jack will take care of the rest.
 
+For a full list of options:
+
+```python -m crackerjack -h```
+
 When you ready to publish your project:
 
 ``python -m crackerjack -p micro``
 
 The -p option not only publishes your project but will bump your
 project version for you. The options are 'micro', 'minor', and 'major'.
+
+## Acknowledgements
+
+## License
+
+BSD-3-Clause

{crackerjack-0.1.10 → crackerjack-0.1.12}/README.md

@@ -6,10 +6,13 @@
 
 Crackerjack is a python coding style which uses a minimalist approach to produce elegant, easy to read, code.
 
+crack·​er·​jack ˈkra-kər-ˌjak
+: a person or thing of marked excellence
+
 ### **Why Crackerjack?**
 
-Crackerjack works on the theory that with static typing and explicit classes,
-functions, variables, and other object names - the code should be
+Crackerjack works on the theory that with static typing and explicit class,
+function, variable, and other object names - the code should be
 straight forward to read and the documentation should pretty much be able to write
 itself. Crackerjack provides a set of guidelines and utilities to keep the codebase clean, elegant, standardized, and
 easily readable.
@@ -30,15 +33,17 @@ This package:
 
 - streamlines code with refurb
 
-- converts/creates documentation in Markdown (md)
-
-- installs, or updates, a projects pre-commit tools and gitignore
+- installs, or updates, a project's pre-commit tools and gitignore
   to comply with evolving crackerjack standards
 
 - removes pipenv, poetry, and hatch build, dependency management, and virtual environment
-  management packages and replace them with PDM using PEP 582
+  management packages and replaces them with PDM using PEP 582
+
+- converts/creates documentation in Markdown (md) - Coming Soon!
 
-- generates pytest mock stubs if needed
+- runs tests and generates pytest mock stubs if needed - Coming Soon!
+
+- bumps the project version and publishes it to PyPI
 
 ### **What are the rules?**
 
@@ -85,9 +90,19 @@ From your projects root directory:
 
 Cracker jack will take care of the rest.
 
+For a full list of options:
+
+```python -m crackerjack -h```
+
 When you ready to publish your project:
 
 ``python -m crackerjack -p micro``
 
 The -p option not only publishes your project but will bump your
 project version for you. The options are 'micro', 'minor', and 'major'.
+
+## Acknowledgements
+
+## License
+
+BSD-3-Clause

{crackerjack-0.1.10 → crackerjack-0.1.12}/crackerjack/.pre-commit-config.yaml

@@ -18,7 +18,7 @@ repos:
       - id: black
         language_version: python3.11
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: v0.0.264
+    rev: v0.0.270
     hooks:
       - id: ruff
   - repo: https://github.com/fredrikaverpil/creosote
@@ -50,7 +50,7 @@ repos:
           - autotyping==23.3.0
           - libcst==0.4.9
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.2.0
+    rev: v1.3.0
     hooks:
       - id: mypy
   #  - repo: https://github.com/pdoc3/pdoc
@@ -64,7 +64,7 @@ repos:
   #        types: [ python ]
   #        always_run: true
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: v0.0.264
+    rev: v0.0.270
     hooks:
       - id: ruff
   - repo: https://github.com/psf/black

{crackerjack-0.1.10 → crackerjack-0.1.12/crackerjack}/pyproject.toml

@@ -30,6 +30,9 @@ target-version = [
 strict = false
 pretty = true
 ignore_missing_imports = false
+plugins = [
+    "pydantic.mypy"
+]
 
 [tool.refurb]
 enable_all = true
@@ -41,7 +44,7 @@ inputs = [
 
 [project]
 name = "Crackerjack"
-version = "0.1.10"
+version = "0.1.6"
 description = "Crackerjack code formatting style."
 requires-python = ">=3.11"
 readme = "README.md"
@@ -53,8 +56,6 @@ keywords = [
     "refurb",
 ]
 classifiers = [
-    "Environment :: Console",
-    "Operating System :: OS Independent",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3.11",
 ]

{crackerjack-0.1.10/crackerjack → crackerjack-0.1.12}/pyproject.toml

@@ -30,13 +30,13 @@ target-version = [
 strict = false
 pretty = true
 ignore_missing_imports = false
-
+plugins = [
+    "pydantic.mypy",
+]
 
 [tool.refurb]
 enable_all = true
 
-
-
 [tool.pytype]
 inputs = [
     "package_name",
@@ -44,7 +44,7 @@ inputs = [
 
 [project]
 name = "Crackerjack"
-version = "0.1.6"
+version = "0.1.12"
 description = "Crackerjack code formatting style."
 requires-python = ">=3.11"
 readme = "README.md"

crackerjack-0.1.10/crackerjack/test1.py

@@ -1,249 +0,0 @@
-"""
-This is the "example" module.
-
-The example module supplies one function, factorial().  For example,
-
-120
-"""
-
-
-def factorial(n):
-    """Return the factorial of n, an exact integer >= 0.
-
-    [1, 1, 2, 6, 24, 120]
-    265252859812191058636308480000000
-    Traceback (most recent call last):
-        ...
-    ValueError: n must be >= 0
-
-    Factorials of floats are OK, but the float must be an exact integer:
-    Traceback (most recent call last):
-        ...
-    ValueError: n must be exact integer
-    265252859812191058636308480000000
-
-    It must also not be ridiculously large:
-    Traceback (most recent call last):
-        ...
-    OverflowError: n too large
-    """
-
-    import math
-
-    if not n >= 0:
-        raise ValueError("n must be >= 0")
-    if math.floor(n) != n:
-        raise ValueError("n must be exact integer")
-    if n + 1 == n:  # catch a value like 1e300
-        raise OverflowError("n too large")
-    result = 1
-    factor = 2
-    while factor <= n:
-        result *= factor
-        factor += 1
-    return result
-
-
-# Fibonacci numbers module
-
-
-def fib(n) -> None:  # write Fibonacci series up to n
-    a, b = 0, 1
-    while a < n:
-        print(a, end=" ")
-        a, b = b, a + b
-    print()
-
-
-def fib2(n):  # return Fibonacci series up to n
-    result = []
-    a, b = 0, 1
-    while a < n:
-        result.append(a)
-        a, b = b, a + b
-    return result
-
-
-def func1(param1: str, param2: str = "default val") -> None:
-    """Description of func with docstring javadoc style.
-    @param param1: descr of param
-    @type param1: type
-    @return: some value
-    @raise KeyError: raises a key exception
-    """
-    pass
-
-
-def func2(param1, param2: str = "default val2") -> list:
-    """Description of func with docstring reST style.
-    :param param1: descr of param
-    :type param1: type
-    :returns: some value
-    :raises keyError: raises exception
-    """
-    pass
-
-
-def func3(param1, param2: str = "default val") -> None:
-    """Description of func with docstring groups style.
-    Params:
-        param1 - descr of param
-    Returns:
-        some value
-    Raises:
-        keyError: raises key exception
-        TypeError: raises type exception
-    """
-    pass
-
-
-class SomeClass(object):
-    """My class."""
-
-    def method(self, prm) -> None:
-        """description"""
-        pass
-
-    def method2(self, prm1, prm2: str = "defaultprm") -> None:
-        pass
-
-    def method_numpy(self) -> None:
-        """
-        My numpydoc description of a kind
-        of very exhautive numpydoc format docstring.
-        Parameters
-        ----------
-        first : array_like
-            the 1st param name `first`
-        second :
-            the 2nd param
-        third : {'value', 'other'}, optional
-            the 3rd param, by default 'value'
-        Returns
-        -------
-        string
-            a value in a string
-        Raises
-        ------
-        KeyError
-            when a key error
-        OtherError
-            when an other error
-        See Also
-        --------
-        a_func : linked (optional), with things to say
-                 on several lines
-        some blabla
-        Note
-        ----
-        Some informations.
-        Some maths also:
-        .. math:: f(x) = e^{- x}
-        References
-        ----------
-        Biblio with cited ref [1]_. The ref can be cited in Note section.
-        .. [1] Adel Daouzli, Sylvain Saïghi, Michelle Rudolph, Alain Destexhe,
-           Sylvie Renaud: Convergence in an Adaptive Neural Network:
-           The Influence of Noise Inputs Correlation. IWANN (1) 2009: 140-148
-        Examples
-        --------
-        This is example of use
-        a
-        """
-        pass
-
-
-"I am a single-line comment"
-
-"""
-I am a
-multi-line comment!
-"""
-
-
-def square(n):
-    """Takes in a number n, returns the square of n"""
-    return n**2
-
-
-def add_binary(a, b):
-    """
-    Returns the sum of two decimal numbers in binary digits.
-
-            Parameters:
-                    a (int): A decimal integer
-                    b (int): Another decimal integer
-
-            Returns:
-                    binary_sum (str): Binary string of the sum of a and b
-    """
-    binary_sum = bin(a + b)[2:]
-    return binary_sum
-
-
-class Person:
-    """
-    A class to represent a person.
-
-    ...
-
-    Attributes
-    ----------
-    name : str
-        first name of the person
-    surname : str
-        family name of the person
-    age : int
-        age of the person
-
-    Methods
-    -------
-    info(additional=""):
-        Prints the person's name and age.
-    """
-
-    def __init__(self, name: str, surname: str, age) -> None:
-        """
-        Constructs all the necessary attributes for the person object.
-
-        Parameters
-        ----------
-            name : str
-                first name of the person
-            surname : str
-                family name of the person
-            age : int
-                age of the person
-        """
-
-        self.name = name
-        self.surname = surname
-        self.age = age
-
-    def info(self, additional: str = "") -> None:
-        """
-        Prints the person's name and age.
-
-        If the argument 'additional' is passed, then it is appended after the main info.
-
-        Parameters
-        ----------
-        additional : str, optional
-            More info to be displayed (default is None)
-
-        Returns
-        -------
-        None
-        """
-
-        print(
-            f"My name is {self.name} {self.surname}. I am {self.age} years old."
-            + additional
-        )
-
-
-
-
-# if __name__ == "__main__":
-#     import doctest
-#     doctest.testmod()