rolling-pin 0.11.1__tar.gz → 0.11.2__tar.gz

{rolling-pin-0.11.1 → rolling-pin-0.11.2}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Alex Braun
+Copyright (c) 2019 Alex Braun
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

{rolling-pin-0.11.1 → rolling-pin-0.11.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: rolling-pin
-Version: 0.11.1
+Version: 0.11.2
 Summary: A library of generic tools for ETL work and visualization of JSON blobs and python repositories
 License: MIT
 Keywords: ETL,blob,dependency,graph,svg,networkx,transform,code metrics,dependency diagram,build system
@@ -15,7 +15,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Typing :: Typed
-Project-URL: documentation, https://thenewflesh.github.io/rolling-pin
+Project-URL: documentation, https://theNewFlesh.github.io/rolling-pin
 Project-URL: repository, https://github.com/theNewFlesh/rolling-pin
 Description-Content-Type: text/markdown
 
@@ -47,8 +47,6 @@ Description-Content-Type: text/markdown
     </a>
 </p>
 
-<!-- <img id="logo" src="resources/logo.png" style="max-width: 717px"> -->
-
 [![](https://img.shields.io/badge/License-MIT-F77E70.svg?style=for-the-badge)](https://github.com/theNewFlesh/rolling-pin/blob/master/LICENSE)
 [![](https://img.shields.io/pypi/pyversions/rolling-pin?style=for-the-badge&label=Python&color=A0D17B&logo=python&logoColor=A0D17B)](https://github.com/theNewFlesh/rolling-pin/blob/master/docker/config/pyproject.toml)
 [![](https://img.shields.io/pypi/v/rolling-pin?style=for-the-badge&label=PyPI&color=5F95DE&logo=pypi&logoColor=5F95DE)](https://pypi.org/project/rolling-pin/)
@@ -62,6 +60,15 @@ blobs and python repositories
 
 See [documentation](https://thenewflesh.github.io/rolling-pin/) for details.
 
+See [blob notebook](https://github.com/theNewFlesh/rolling-pin/blob/master/notebooks/demo-blob.ipynb)
+for a demo of the BlobETL class.
+
+See [conform notebook](https://github.com/theNewFlesh/rolling-pin/blob/master/notebooks/demo-conform.ipynb)
+for a demo of the ConformETL class.
+
+See [cli notebook](https://github.com/theNewFlesh/rolling-pin/blob/master/notebooks/demo-cli.ipynb)
+for a demo of the rolling-pin CLI.
+
 On the documentation main page, under the *Architecture* section, is a
 dynamically generated dependency graph of rolling-pin's current architecture.
 It is generated using the RepoETL class.
@@ -69,10 +76,6 @@ It is generated using the RepoETL class.
 If you look under the *Metrics* section you will find Radon code metric plots
 and data of the rolling-pin source code, generated by the RadonETL class.
 
-Also have a look at this
-**[Jupyter notebook demo](https://github.com/theNewFlesh/rolling-pin/blob/master/notebooks/prototype_demo.ipynb)**
-for a taste of what rolling-pin can do.
-
 ---
 
 # Installation for Developers
@@ -112,6 +115,9 @@ Run `bin/rolling-pin --help` for more help on the command line tool.
 ### Python
 `pip install rolling-pin`
 
+Please see the prod.dockerfile for an official example of how to build a docker
+image with rolling-pin.
+
 ### Docker
 1. Install [docker-desktop](https://docs.docker.com/desktop/)
 2. `docker pull theNewFlesh/rolling-pin:[mode]-[version]`
@@ -239,6 +245,7 @@ The following is a complete list of all available development commands:
 | test-coverage              | Generate test coverage report                                       |
 | test-dev                   | Run all tests                                                       |
 | test-fast                  | Test all code excepts tests marked with SKIP_SLOWS_TESTS decorator  |
+| test-format                | Format all python files                                             |
 | test-lint                  | Run linting and type checking                                       |
 | test-prod                  | Run tests across all support python versions                        |
 | version                    | Full resolution of repo: dependencies, linting, tests, docs, etc    |

{rolling-pin-0.11.1 → rolling-pin-0.11.2}/README.md

@@ -26,8 +26,6 @@
     </a>
 </p>
 
-<!-- <img id="logo" src="resources/logo.png" style="max-width: 717px"> -->
-
 [![](https://img.shields.io/badge/License-MIT-F77E70.svg?style=for-the-badge)](https://github.com/theNewFlesh/rolling-pin/blob/master/LICENSE)
 [![](https://img.shields.io/pypi/pyversions/rolling-pin?style=for-the-badge&label=Python&color=A0D17B&logo=python&logoColor=A0D17B)](https://github.com/theNewFlesh/rolling-pin/blob/master/docker/config/pyproject.toml)
 [![](https://img.shields.io/pypi/v/rolling-pin?style=for-the-badge&label=PyPI&color=5F95DE&logo=pypi&logoColor=5F95DE)](https://pypi.org/project/rolling-pin/)
@@ -41,6 +39,15 @@ blobs and python repositories
 
 See [documentation](https://thenewflesh.github.io/rolling-pin/) for details.
 
+See [blob notebook](https://github.com/theNewFlesh/rolling-pin/blob/master/notebooks/demo-blob.ipynb)
+for a demo of the BlobETL class.
+
+See [conform notebook](https://github.com/theNewFlesh/rolling-pin/blob/master/notebooks/demo-conform.ipynb)
+for a demo of the ConformETL class.
+
+See [cli notebook](https://github.com/theNewFlesh/rolling-pin/blob/master/notebooks/demo-cli.ipynb)
+for a demo of the rolling-pin CLI.
+
 On the documentation main page, under the *Architecture* section, is a
 dynamically generated dependency graph of rolling-pin's current architecture.
 It is generated using the RepoETL class.
@@ -48,10 +55,6 @@ It is generated using the RepoETL class.
 If you look under the *Metrics* section you will find Radon code metric plots
 and data of the rolling-pin source code, generated by the RadonETL class.
 
-Also have a look at this
-**[Jupyter notebook demo](https://github.com/theNewFlesh/rolling-pin/blob/master/notebooks/prototype_demo.ipynb)**
-for a taste of what rolling-pin can do.
-
 ---
 
 # Installation for Developers
@@ -91,6 +94,9 @@ Run `bin/rolling-pin --help` for more help on the command line tool.
 ### Python
 `pip install rolling-pin`
 
+Please see the prod.dockerfile for an official example of how to build a docker
+image with rolling-pin.
+
 ### Docker
 1. Install [docker-desktop](https://docs.docker.com/desktop/)
 2. `docker pull theNewFlesh/rolling-pin:[mode]-[version]`
@@ -218,6 +224,7 @@ The following is a complete list of all available development commands:
 | test-coverage              | Generate test coverage report                                       |
 | test-dev                   | Run all tests                                                       |
 | test-fast                  | Test all code excepts tests marked with SKIP_SLOWS_TESTS decorator  |
+| test-format                | Format all python files                                             |
 | test-lint                  | Run linting and type checking                                       |
 | test-prod                  | Run tests across all support python versions                        |
 | version                    | Full resolution of repo: dependencies, linting, tests, docs, etc    |

{rolling-pin-0.11.1 → rolling-pin-0.11.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "rolling-pin"
-version = "0.11.1"
+version = "0.11.2"
 description = "A library of generic tools for ETL work and visualization of JSON blobs and python repositories"
 readme = "README.md"
 license = "MIT"
@@ -32,7 +32,7 @@ dependencies = [
     "click>=8.1.3",
     "graphviz",
     "ipython",
-    "lunchbox",
+    "lunchbox>=0.6.1",
     "networkx",
     "numpy>=1.23.4",
     "pandas>=1.1.5",
@@ -50,7 +50,7 @@ authors = [
 
 [project.urls]
 repository = "https://github.com/theNewFlesh/rolling-pin"
-documentation = "https://thenewflesh.github.io/rolling-pin"
+documentation = "https://theNewFlesh.github.io/rolling-pin"
 
 [project.scripts]
 rolling-pin = "rolling_pin.command:main"
@@ -61,6 +61,33 @@ requires = [
 ]
 build-backend = "pdm.pep517.api"
 
+[tool.ruff]
+cache-dir = "/home/ubuntu/.cache/ruff"
+line-length = 100
+indent-width = 4
+exclude = [
+    "*_test.py",
+]
+
+[tool.ruff.format]
+quote-style = "preserve"
+indent-style = "space"
+docstring-code-format = true
+skip-magic-trailing-comma = true
+
+[tool.ruff.lint]
+select = [
+    "E",
+    "F",
+]
+ignore = [
+    "E731",
+]
+
+[tool.ruff.lint.flake8-quotes]
+docstring-quotes = "single"
+inline-quotes = "single"
+
 [tool.uv]
 cache-dir = "/home/ubuntu/pdm/cache"
 

{rolling-pin-0.11.1 → rolling-pin-0.11.2}/rolling_pin/blob_etl.py

@@ -23,7 +23,7 @@ converted to directed graphs.
 '''
 
 
-class BlobETL():
+class BlobETL:
     '''
     Converts blob data internally into a flat dictionary that is universally
     searchable, editable and convertable back to the data's original structure,

{rolling-pin-0.11.1 → rolling-pin-0.11.2}/rolling_pin/command.py

@@ -1,6 +1,7 @@
 import subprocess
 
 import click
+import lunchbox.theme as lbc
 
 from rolling_pin.conform_etl import ConformETL
 from rolling_pin.radon_etl import RadonETL
@@ -12,6 +13,8 @@ from rolling_pin.toml_etl import TomlETL
 Command line interface to rolling-pin library
 '''
 
+click.Context.formatter_class = lbc.ThemeFormatter
+
 
 @click.group()
 def main():
@@ -35,11 +38,12 @@ def main():
 def conform(source, groups, dryrun):
     # type: (str, str, bool) -> None
     '''
-    Copies source files to target filepaths according to given conform file.
+    {white}Copies source files to target filepaths according to given conform
+    file.{clear}
 
     \b
-    Arguments:
-        SOURCE - conform YAML filepath
+    {cyan2}ARGUMENTS{clear}
+        {cyan2}source{clear}  conform YAML filepath
     '''
     etl = ConformETL.from_yaml(source)
     if dryrun:
@@ -72,13 +76,13 @@ def conform(source, groups, dryrun):
 def graph(source, target, include, exclude, orient):
     # type: (str, str, str, str, str) -> None
     '''
-    Generate a dependency graph of a source repository and write it to a given
-    filepath
+    {white}Generate a dependency graph of a source repository and write it to a
+    given filepath{clear}
 
     \b
-    Arguments:
-        SOURCE - repository path
-        TARGET - target filepath
+    {cyan2}ARGUMENTS{clear}
+        {cyan2}source{clear}  repository path
+        {cyan2}target{clear}  target filepath
     '''
     include_ = '' if include is None else include
     exclude_ = '' if exclude is None else exclude
@@ -91,12 +95,13 @@ def graph(source, target, include, exclude, orient):
 def plot(source, target):
     # type: (str, str) -> None
     '''
-    Write radon metrics plots of given repository to given filepath
+    {white}Write radon metrics plots of given repository to given filepath.
+    {clear}
 
     \b
-    Arguments:
-        SOURCE - repository path
-        TARGET - plot filepath
+    {cyan2}ARGUMENTS{clear}
+        {cyan2}source{clear}  repository path
+        {cyan2}target{clear}  plot filepath
     '''
     RadonETL(source).write_plots(target)
 
@@ -107,12 +112,13 @@ def plot(source, target):
 def table(source, target):
     # type: (str, str) -> None
     '''
-    Write radon metrics tables of given repository to given directory
+    {white}Write radon metrics tables of given repository to given directory
+    {clear}
 
     \b
-    Arguments:
-        SOURCE - repository path
-        TARGET - table directory
+    {cyan2}ARGUMENTS{clear}
+        {cyan2}source{clear}  repository path
+        {cyan2}target{clear}  table directory
     '''
     RadonETL(source).write_tables(target)
 
@@ -149,19 +155,15 @@ value pair in TOML format''',
 def toml(source, edit, delete, search, target):
     # type: (str, tuple[str], tuple[str], str, str) -> None
     '''
-    Generate a copy of a given TOML file with given edits indicated by flags.
-    Flags are evalauted in the following order: edit, delete, search.
-    Flags may be arbitrarily combined.
-    Edit and delete flags may appear multiple times.
-
-    \b
-    Arguments:
-        SOURCE - TOML filepath
+    {white}Generate a copy of a given TOML file with given edits indicated by
+    flags. Flags are evalauted in the following order: edit, delete, search.
+    Flags may be arbitrarily combined. Edit and delete flags may appear multiple
+    times.{clear}
 
     \b
-    EXAMPLES
-        EXAMPLE-FILE------------------------------------------------------------
-            >>>cat example.toml
+    {yellow2}EXAMPLES
+        EXAMPLE-FILE------------------------------------------------------------{clear}
+            {blue2}>>>{clear}cat example.toml{purple2}
             [root]
             a = 1
             b = 2
@@ -173,16 +175,16 @@ def toml(source, edit, delete, search, target):
             hello = true
 
     \b
-        EDIT-FLAG---------------------------------------------------------------
-            >>>rolling-pin toml foobar.toml --edit 'root.a=999'
+        {yellow2}EDIT-FLAG-------------------------------------------------------------------{clear}
+            {blue2}>>>{clear}rolling-pin toml foobar.toml --edit 'root.a=999'{purple2}
             [root]
             a = 999
             b = 2...
     \b
-            --------------------------------------------------------------------
-            >>>rolling-pin toml foobar.toml \\
+            {yellow2}--------------------------------------------------------------------{clear}
+            {blue2}>>>{clear}rolling-pin toml foobar.toml \\
                    --edit 'root.a=[1, 2]'   \\
-                   --edit 'root.b="xxx"'
+                   --edit 'root.b="xxx"'{purple2}
             [root]
             a = [
                 1,
@@ -190,8 +192,8 @@ def toml(source, edit, delete, search, target):
             ]
             b = "xxx"...
     \b
-            --------------------------------------------------------------------
-            >>>rolling-pin toml foobar.toml --edit 'root.foo.bar="baz"'
+            {yellow2}--------------------------------------------------------------------{clear}
+            {blue2}>>>{clear}rolling-pin toml foobar.toml --edit 'root.foo.bar="baz"'{purple2}
             ...
             hello = true
     \b
@@ -199,10 +201,10 @@ def toml(source, edit, delete, search, target):
             bar = "baz"...
 
     \b
-        DELETE-FLAG-------------------------------------------------------------
-            >>>rolling-pin toml foobar.toml \\
+        {yellow2}DELETE-FLAG-------------------------------------------------------------{clear}
+            {blue2}>>>{clear}rolling-pin toml foobar.toml \\
                    --delete 'root.foo.bar'  \\
-                   --delete 'root.a'
+                   --delete 'root.a'{purple2}
             [root]
             b = 2
     \b
@@ -210,13 +212,17 @@ def toml(source, edit, delete, search, target):
             hello = true
 
     \b
-        SEARCH-FLAG-------------------------------------------------------------
-            >>>rolling-pin toml foobar.toml --search 'root.foo|world'
+        {yellow2}SEARCH-FLAG-------------------------------------------------------------{clear}
+            {blue2}>>>{clear}rolling-pin toml foobar.toml --search 'root.foo|world'{purple2}
             [world]
             hello = true
     \b
             [root.foo.bar]
             x = "y"
+
+    \b
+    {cyan2}ARGUMENTS{clear}
+        {cyan2}source{clear}  TOML filepath
     '''
     etl = TomlETL.from_toml(source)
     for e in edit:
@@ -234,7 +240,8 @@ def toml(source, edit, delete, search, target):
 @main.command()
 def bash_completion():
     '''
-    BASH completion code to be written to a _rolling-pin completion file.
+    {white}BASH completion code to be written to a _rolling-pin completion file.
+    {clear}
     '''
     cmd = '_ROLLING_PIN_COMPLETE=bash_source rolling-pin'
     result = subprocess.Popen(cmd, shell=True, stdout=subprocess.PIPE)
@@ -245,7 +252,8 @@ def bash_completion():
 @main.command()
 def zsh_completion():
     '''
-    ZSH completion code to be written to a _rolling-pin completion file.
+    {white}ZSH completion code to be written to a _rolling-pin completion file.
+    {clear}
     '''
     cmd = '_ROLLING_PIN_COMPLETE=zsh_source rolling-pin'
     result = subprocess.Popen(cmd, shell=True, stdout=subprocess.PIPE)

{rolling-pin-0.11.1 → rolling-pin-0.11.2}/rolling_pin/radon_etl.py

@@ -23,7 +23,7 @@ code wthin a given directory.
 '''
 
 
-class RadonETL():
+class RadonETL:
     '''
     Conforms all four radon reports (raw metrics, Halstead, maintainability and
     cyclomatic complexity) into a single DataFrame that can then be plotted.

{rolling-pin-0.11.1 → rolling-pin-0.11.2}/rolling_pin/repo_etl.py

@@ -21,7 +21,7 @@ dependencies into a directed graph.
 '''
 
 
-class RepoETL():
+class RepoETL:
     '''
     RepoETL is a class for extracting 1st order dependencies of modules within a
     given repository. This information is stored internally as a DataFrame and