rich-objects 0.2.2__tar.gz → 0.3.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- rich_objects-0.3.0/.github/pull_request_template.md +22 -0
- rich_objects-0.3.0/.github/workflows/lint.yaml +26 -0
- rich_objects-0.3.0/.github/workflows/pypi_publish.yaml +71 -0
- rich_objects-0.3.0/.github/workflows/test.yaml +89 -0
- rich_objects-0.3.0/.gitignore +199 -0
- rich_objects-0.3.0/Makefile +51 -0
- {rich_objects-0.2.2 → rich_objects-0.3.0}/PKG-INFO +26 -15
- {rich_objects-0.2.2 → rich_objects-0.3.0}/README.md +20 -6
- {rich_objects-0.2.2 → rich_objects-0.3.0}/pyproject.toml +11 -10
- {rich_objects-0.2.2 → rich_objects-0.3.0}/rich_objects/display.py +14 -3
- rich_objects-0.3.0/tests/__init__.py +0 -0
- rich_objects-0.3.0/tests/helpers.py +20 -0
- rich_objects-0.3.0/tests/test_console.py +21 -0
- rich_objects-0.3.0/tests/test_display.py +614 -0
- rich_objects-0.3.0/uv.lock +421 -0
- {rich_objects-0.2.2 → rich_objects-0.3.0}/LICENSE +0 -0
- {rich_objects-0.2.2 → rich_objects-0.3.0}/rich_objects/__init__.py +0 -0
- {rich_objects-0.2.2 → rich_objects-0.3.0}/rich_objects/console.py +0 -0
- {rich_objects-0.2.2 → rich_objects-0.3.0}/rich_objects/constants.py +0 -0
- {rich_objects-0.2.2 → rich_objects-0.3.0}/rich_objects/enums.py +0 -0
- {rich_objects-0.2.2 → rich_objects-0.3.0}/rich_objects/rich_table.py +0 -0
- {rich_objects-0.2.2 → rich_objects-0.3.0}/rich_objects/table_config.py +0 -0
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
## RATIONALE
|
|
2
|
+
<!--
|
|
3
|
+
For best reviews, please explain why this change is being done. It is not always obvious
|
|
4
|
+
from the code, and the folks reviewing may not respond quickly.
|
|
5
|
+
-->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
## CHANGES
|
|
10
|
+
<!-- Please explain at a high-level the changes. -->
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
<!-- Recommended addition sections:
|
|
15
|
+
## TESTING
|
|
16
|
+
## SCREENSHOTS
|
|
17
|
+
## NOTES
|
|
18
|
+
## TODO
|
|
19
|
+
## RELATED
|
|
20
|
+
## REVIEWERS
|
|
21
|
+
|
|
22
|
+
-->
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
name: Lint
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches:
|
|
6
|
+
- main
|
|
7
|
+
pull_request:
|
|
8
|
+
types:
|
|
9
|
+
- opened
|
|
10
|
+
- synchronize
|
|
11
|
+
|
|
12
|
+
jobs:
|
|
13
|
+
lint:
|
|
14
|
+
runs-on: ubuntu-latest
|
|
15
|
+
steps:
|
|
16
|
+
- name: Dump GitHub context
|
|
17
|
+
env:
|
|
18
|
+
GITHUB_CONTEXT: ${{ toJson(github) }}
|
|
19
|
+
run: echo "$GITHUB_CONTEXT"
|
|
20
|
+
- uses: actions/checkout@v4
|
|
21
|
+
- name: Install uv
|
|
22
|
+
uses: astral-sh/setup-uv@v6
|
|
23
|
+
- name: Install the project dependencies
|
|
24
|
+
run: uv sync --frozen
|
|
25
|
+
- name: Lint (ruff)
|
|
26
|
+
run: uv run ruff check
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
# This workflow will upload a Python Package to PyPI when a release is created
|
|
2
|
+
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
|
|
3
|
+
|
|
4
|
+
# This workflow uses actions that are not certified by GitHub.
|
|
5
|
+
# They are provided by a third-party and are governed by
|
|
6
|
+
# separate terms of service, privacy policy, and support
|
|
7
|
+
# documentation.
|
|
8
|
+
|
|
9
|
+
name: Upload Python Package
|
|
10
|
+
|
|
11
|
+
on:
|
|
12
|
+
release:
|
|
13
|
+
types: [published]
|
|
14
|
+
|
|
15
|
+
permissions:
|
|
16
|
+
contents: read
|
|
17
|
+
|
|
18
|
+
jobs:
|
|
19
|
+
release-build:
|
|
20
|
+
runs-on: ubuntu-latest
|
|
21
|
+
|
|
22
|
+
steps:
|
|
23
|
+
- name: Dump GitHub context
|
|
24
|
+
env:
|
|
25
|
+
GITHUB_CONTEXT: ${{ toJson(github) }}
|
|
26
|
+
run: echo "$GITHUB_CONTEXT"
|
|
27
|
+
|
|
28
|
+
- uses: actions/checkout@v4
|
|
29
|
+
|
|
30
|
+
- name: Install uv
|
|
31
|
+
uses: astral-sh/setup-uv@v6
|
|
32
|
+
|
|
33
|
+
- name: Build release distributions
|
|
34
|
+
run: uv build
|
|
35
|
+
|
|
36
|
+
- name: Upload distributions
|
|
37
|
+
uses: actions/upload-artifact@v4
|
|
38
|
+
with:
|
|
39
|
+
name: release-dists
|
|
40
|
+
path: dist/
|
|
41
|
+
|
|
42
|
+
pypi-publish:
|
|
43
|
+
runs-on: ubuntu-latest
|
|
44
|
+
needs:
|
|
45
|
+
- release-build
|
|
46
|
+
permissions:
|
|
47
|
+
# IMPORTANT: this permission is mandatory for trusted publishing
|
|
48
|
+
id-token: write
|
|
49
|
+
|
|
50
|
+
# Dedicated environments with protections for publishing are strongly recommended.
|
|
51
|
+
# For more information, see: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules
|
|
52
|
+
environment:
|
|
53
|
+
name: pypi
|
|
54
|
+
# OPTIONAL: uncomment and update to include your PyPI project URL in the deployment status:
|
|
55
|
+
# url: https://pypi.org/p/YOURPROJECT
|
|
56
|
+
#
|
|
57
|
+
# ALTERNATIVE: if your GitHub Release name is the PyPI project version string
|
|
58
|
+
# ALTERNATIVE: exactly, uncomment the following line instead:
|
|
59
|
+
# url: https://pypi.org/project/YOURPROJECT/${{ github.event.release.name }}
|
|
60
|
+
|
|
61
|
+
steps:
|
|
62
|
+
- name: Retrieve release distributions
|
|
63
|
+
uses: actions/download-artifact@v4
|
|
64
|
+
with:
|
|
65
|
+
name: release-dists
|
|
66
|
+
path: dist/
|
|
67
|
+
|
|
68
|
+
- name: Publish release distributions to PyPI
|
|
69
|
+
uses: pypa/gh-action-pypi-publish@release/v1
|
|
70
|
+
with:
|
|
71
|
+
packages-dir: dist/
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
name: Test
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches:
|
|
6
|
+
- main
|
|
7
|
+
pull_request:
|
|
8
|
+
types:
|
|
9
|
+
- opened
|
|
10
|
+
- synchronize
|
|
11
|
+
|
|
12
|
+
jobs:
|
|
13
|
+
test:
|
|
14
|
+
strategy:
|
|
15
|
+
matrix:
|
|
16
|
+
os: [ ubuntu-latest, windows-latest, macos-latest ]
|
|
17
|
+
python-version: [ "3.14" ]
|
|
18
|
+
include:
|
|
19
|
+
- os: ubuntu-latest
|
|
20
|
+
python-version: "3.10"
|
|
21
|
+
- os: macos-latest
|
|
22
|
+
python-version: "3.11"
|
|
23
|
+
- os: windows-latest
|
|
24
|
+
python-version: "3.12"
|
|
25
|
+
- os: windows-latest
|
|
26
|
+
python-version: "3.13"
|
|
27
|
+
fail-fast: false
|
|
28
|
+
runs-on: ${{ matrix.os }}
|
|
29
|
+
steps:
|
|
30
|
+
- name: Dump GitHub context
|
|
31
|
+
env:
|
|
32
|
+
GITHUB_CONTEXT: ${{ toJson(github) }}
|
|
33
|
+
run: echo "$GITHUB_CONTEXT"
|
|
34
|
+
- uses: actions/checkout@v4
|
|
35
|
+
- name: Install uv
|
|
36
|
+
uses: astral-sh/setup-uv@v6
|
|
37
|
+
with:
|
|
38
|
+
python-version: ${{ matrix.python-version }}
|
|
39
|
+
enable-cache: true
|
|
40
|
+
- name: Install the project dependencies
|
|
41
|
+
run: uv sync --frozen
|
|
42
|
+
- name: Test
|
|
43
|
+
run: uv run coverage run -m pytest --showlocals -v tests
|
|
44
|
+
env:
|
|
45
|
+
COVERAGE_FILE: coverage/.coverage.${{ runner.os }}-py${{ matrix.python-version }}
|
|
46
|
+
CONTEXT: ${{ runner.os }}-py${{ matrix.python-version }}
|
|
47
|
+
- name: Store coverage files
|
|
48
|
+
uses: actions/upload-artifact@v4
|
|
49
|
+
with:
|
|
50
|
+
name: coverage-${{ runner.os }}-${{ matrix.python-version }}
|
|
51
|
+
path: coverage
|
|
52
|
+
include-hidden-files: true
|
|
53
|
+
|
|
54
|
+
coverage-combine:
|
|
55
|
+
needs: [test]
|
|
56
|
+
runs-on: ubuntu-latest
|
|
57
|
+
steps:
|
|
58
|
+
- name: Dump GitHub context
|
|
59
|
+
env:
|
|
60
|
+
GITHUB_CONTEXT: ${{ toJson(github) }}
|
|
61
|
+
run: echo "$GITHUB_CONTEXT"
|
|
62
|
+
- uses: actions/checkout@v4
|
|
63
|
+
- name: Install uv
|
|
64
|
+
uses: astral-sh/setup-uv@v6
|
|
65
|
+
with:
|
|
66
|
+
python-version: "3.12"
|
|
67
|
+
enable-cache: true
|
|
68
|
+
- name: Install the project dependencies
|
|
69
|
+
run: uv sync --frozen
|
|
70
|
+
- name: Get coverage files
|
|
71
|
+
uses: actions/download-artifact@v4
|
|
72
|
+
with:
|
|
73
|
+
pattern: coverage-*
|
|
74
|
+
path: coverage
|
|
75
|
+
merge-multiple: true
|
|
76
|
+
- name: List coverage files
|
|
77
|
+
run: ls -la coverage
|
|
78
|
+
- name: Combine coverage
|
|
79
|
+
run: uv run coverage combine coverage
|
|
80
|
+
- name: Coverage report
|
|
81
|
+
run: uv run coverage report --skip-empty --show-missing --include=rich_objects/*
|
|
82
|
+
- name: Coverage HTML
|
|
83
|
+
run: uv run coverage html --show-contexts --title "Coverage for ${{ github.sha }}" --include=rich_objects/*
|
|
84
|
+
- name: Store coverage HTML
|
|
85
|
+
uses: actions/upload-artifact@v4
|
|
86
|
+
with:
|
|
87
|
+
name: coverage-html
|
|
88
|
+
path: htmlcov
|
|
89
|
+
include-hidden-files: true
|
|
@@ -0,0 +1,199 @@
|
|
|
1
|
+
# Byte-compiled / optimized / DLL files
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.py[codz]
|
|
4
|
+
*$py.class
|
|
5
|
+
|
|
6
|
+
# C extensions
|
|
7
|
+
*.so
|
|
8
|
+
|
|
9
|
+
# Distribution / packaging
|
|
10
|
+
.Python
|
|
11
|
+
build/
|
|
12
|
+
develop-eggs/
|
|
13
|
+
dist/
|
|
14
|
+
downloads/
|
|
15
|
+
eggs/
|
|
16
|
+
.eggs/
|
|
17
|
+
lib/
|
|
18
|
+
lib64/
|
|
19
|
+
parts/
|
|
20
|
+
sdist/
|
|
21
|
+
var/
|
|
22
|
+
wheels/
|
|
23
|
+
share/python-wheels/
|
|
24
|
+
*.egg-info/
|
|
25
|
+
.installed.cfg
|
|
26
|
+
*.egg
|
|
27
|
+
MANIFEST
|
|
28
|
+
|
|
29
|
+
# PyInstaller
|
|
30
|
+
# Usually these files are written by a python script from a template
|
|
31
|
+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
|
32
|
+
*.manifest
|
|
33
|
+
*.spec
|
|
34
|
+
|
|
35
|
+
# Installer logs
|
|
36
|
+
pip-log.txt
|
|
37
|
+
pip-delete-this-directory.txt
|
|
38
|
+
|
|
39
|
+
# Unit test / coverage reports
|
|
40
|
+
htmlcov/
|
|
41
|
+
.tox/
|
|
42
|
+
.nox/
|
|
43
|
+
.coverage
|
|
44
|
+
.coverage.*
|
|
45
|
+
.cache
|
|
46
|
+
nosetests.xml
|
|
47
|
+
coverage.xml
|
|
48
|
+
*.cover
|
|
49
|
+
*.py.cover
|
|
50
|
+
.hypothesis/
|
|
51
|
+
.pytest_cache/
|
|
52
|
+
cover/
|
|
53
|
+
|
|
54
|
+
# Translations
|
|
55
|
+
*.mo
|
|
56
|
+
*.pot
|
|
57
|
+
|
|
58
|
+
# Django stuff:
|
|
59
|
+
*.log
|
|
60
|
+
local_settings.py
|
|
61
|
+
db.sqlite3
|
|
62
|
+
db.sqlite3-journal
|
|
63
|
+
|
|
64
|
+
# Flask stuff:
|
|
65
|
+
instance/
|
|
66
|
+
.webassets-cache
|
|
67
|
+
|
|
68
|
+
# Scrapy stuff:
|
|
69
|
+
.scrapy
|
|
70
|
+
|
|
71
|
+
# Sphinx documentation
|
|
72
|
+
docs/_build/
|
|
73
|
+
|
|
74
|
+
# PyBuilder
|
|
75
|
+
.pybuilder/
|
|
76
|
+
target/
|
|
77
|
+
|
|
78
|
+
# Jupyter Notebook
|
|
79
|
+
.ipynb_checkpoints
|
|
80
|
+
|
|
81
|
+
# IPython
|
|
82
|
+
profile_default/
|
|
83
|
+
ipython_config.py
|
|
84
|
+
|
|
85
|
+
# pyenv
|
|
86
|
+
# For a library or package, you might want to ignore these files since the code is
|
|
87
|
+
# intended to run in multiple environments; otherwise, check them in:
|
|
88
|
+
# .python-version
|
|
89
|
+
|
|
90
|
+
# pipenv
|
|
91
|
+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
|
92
|
+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
|
|
93
|
+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
|
|
94
|
+
# install all needed dependencies.
|
|
95
|
+
#Pipfile.lock
|
|
96
|
+
|
|
97
|
+
# UV
|
|
98
|
+
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
|
|
99
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
100
|
+
# commonly ignored for libraries.
|
|
101
|
+
#uv.lock
|
|
102
|
+
|
|
103
|
+
# pdm
|
|
104
|
+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
|
|
105
|
+
# pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
|
|
106
|
+
# https://pdm-project.org/en/latest/usage/project/#working-with-version-control
|
|
107
|
+
#pdm.lock
|
|
108
|
+
#pdm.toml
|
|
109
|
+
.pdm-python
|
|
110
|
+
.pdm-build/
|
|
111
|
+
|
|
112
|
+
# pixi
|
|
113
|
+
# Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
|
|
114
|
+
#pixi.lock
|
|
115
|
+
# Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
|
|
116
|
+
# in the .venv directory. It is recommended not to include this directory in version control.
|
|
117
|
+
.pixi
|
|
118
|
+
|
|
119
|
+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
|
|
120
|
+
__pypackages__/
|
|
121
|
+
|
|
122
|
+
# Celery stuff
|
|
123
|
+
celerybeat-schedule
|
|
124
|
+
celerybeat.pid
|
|
125
|
+
|
|
126
|
+
# SageMath parsed files
|
|
127
|
+
*.sage.py
|
|
128
|
+
|
|
129
|
+
# Environments
|
|
130
|
+
.env
|
|
131
|
+
.envrc
|
|
132
|
+
.venv
|
|
133
|
+
env/
|
|
134
|
+
venv/
|
|
135
|
+
ENV/
|
|
136
|
+
env.bak/
|
|
137
|
+
venv.bak/
|
|
138
|
+
|
|
139
|
+
# Spyder project settings
|
|
140
|
+
.spyderproject
|
|
141
|
+
.spyproject
|
|
142
|
+
|
|
143
|
+
# Rope project settings
|
|
144
|
+
.ropeproject
|
|
145
|
+
|
|
146
|
+
# mkdocs documentation
|
|
147
|
+
/site
|
|
148
|
+
|
|
149
|
+
# mypy
|
|
150
|
+
.mypy_cache/
|
|
151
|
+
.dmypy.json
|
|
152
|
+
dmypy.json
|
|
153
|
+
|
|
154
|
+
# Pyre type checker
|
|
155
|
+
.pyre/
|
|
156
|
+
|
|
157
|
+
# pytype static type analyzer
|
|
158
|
+
.pytype/
|
|
159
|
+
|
|
160
|
+
# Cython debug symbols
|
|
161
|
+
cython_debug/
|
|
162
|
+
|
|
163
|
+
# PyCharm
|
|
164
|
+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
|
|
165
|
+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
|
|
166
|
+
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
|
167
|
+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
|
168
|
+
#.idea/
|
|
169
|
+
|
|
170
|
+
# Abstra
|
|
171
|
+
# Abstra is an AI-powered process automation framework.
|
|
172
|
+
# Ignore directories containing user credentials, local state, and settings.
|
|
173
|
+
# Learn more at https://abstra.io/docs
|
|
174
|
+
.abstra/
|
|
175
|
+
|
|
176
|
+
# Visual Studio Code
|
|
177
|
+
# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
|
|
178
|
+
# that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
|
|
179
|
+
# and can be added to the global gitignore or merged into this file. However, if you prefer,
|
|
180
|
+
# you could uncomment the following to ignore the entire vscode folder
|
|
181
|
+
# .vscode/
|
|
182
|
+
|
|
183
|
+
# Ruff stuff:
|
|
184
|
+
.ruff_cache/
|
|
185
|
+
|
|
186
|
+
# PyPI configuration file
|
|
187
|
+
.pypirc
|
|
188
|
+
|
|
189
|
+
# Cursor
|
|
190
|
+
# Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
|
|
191
|
+
# exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
|
|
192
|
+
# refer to https://docs.cursor.com/context/ignore-files
|
|
193
|
+
.cursorignore
|
|
194
|
+
.cursorindexingignore
|
|
195
|
+
|
|
196
|
+
# Marimo
|
|
197
|
+
marimo/_static/
|
|
198
|
+
marimo/_lsp/
|
|
199
|
+
__marimo__/
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# the first target is the default, so just run help
|
|
2
|
+
help: ## This message
|
|
3
|
+
@echo "===================="
|
|
4
|
+
@echo " Available Commands"
|
|
5
|
+
@echo "===================="
|
|
6
|
+
@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n make \033[36m\033[0m\n"} /^[$$()% a-zA-Z_-]+:.*?##/ { printf " \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
|
|
7
|
+
|
|
8
|
+
TEST_TARGET ?= tests
|
|
9
|
+
uv_run ?= uv run
|
|
10
|
+
|
|
11
|
+
default: help
|
|
12
|
+
|
|
13
|
+
###########
|
|
14
|
+
##@ General
|
|
15
|
+
all: lint cov wheel ## Complete cycle: lint/test everything
|
|
16
|
+
|
|
17
|
+
clean: ## Remove build/test artifacts
|
|
18
|
+
rm -rf `find . -name __pycache__`
|
|
19
|
+
rm -rf `find . -name .pytest_cache`
|
|
20
|
+
rm -rf `find . -name .ruff_cache`
|
|
21
|
+
rm -rf `find . -name .coverage`
|
|
22
|
+
rm -rf `find . -name htmlcov`
|
|
23
|
+
rm -rf `find . -name dist`
|
|
24
|
+
|
|
25
|
+
###########
|
|
26
|
+
##@ Build
|
|
27
|
+
build: wheel
|
|
28
|
+
wheel: ## Build the wheel file
|
|
29
|
+
uv build
|
|
30
|
+
|
|
31
|
+
prereq: install
|
|
32
|
+
install: ## Install package(s) and development tools
|
|
33
|
+
uv sync
|
|
34
|
+
|
|
35
|
+
###########
|
|
36
|
+
##@ Lint
|
|
37
|
+
lint: ## Check code formatting
|
|
38
|
+
$(uv_run) ruff check
|
|
39
|
+
|
|
40
|
+
delint: ## Fix formatting issues
|
|
41
|
+
$(uv_run) ruff check --fix
|
|
42
|
+
|
|
43
|
+
###########
|
|
44
|
+
##@ Test
|
|
45
|
+
test: ## Run unit tests (use TEST_TARGET to scope)
|
|
46
|
+
$(uv_run) pytest -v $(TEST_TARGET)
|
|
47
|
+
|
|
48
|
+
cov: ## Run unit tests with code coverage measurments (use TEST_TARGET to scope)
|
|
49
|
+
$(uv_run) coverage run -m pytest -v $(TEST_TARGET)
|
|
50
|
+
$(uv_run) coverage report -m
|
|
51
|
+
$(uv_run) coverage html
|
|
@@ -1,11 +1,9 @@
|
|
|
1
|
-
Metadata-Version: 2.
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
2
|
Name: rich-objects
|
|
3
|
-
Version: 0.
|
|
3
|
+
Version: 0.3.0
|
|
4
4
|
Summary: Tools to rich print complex objects (e.g. JSON responses)
|
|
5
|
+
Author-email: Rick Porter <rickwporter@gmail.com>
|
|
5
6
|
License-File: LICENSE
|
|
6
|
-
Author: Rick Porter
|
|
7
|
-
Author-email: rickwporter@gmail.com
|
|
8
|
-
Requires-Python: >=3.9
|
|
9
7
|
Classifier: Development Status :: 4 - Beta
|
|
10
8
|
Classifier: Environment :: Console
|
|
11
9
|
Classifier: Intended Audience :: Developers
|
|
@@ -13,7 +11,6 @@ Classifier: Operating System :: OS Independent
|
|
|
13
11
|
Classifier: Programming Language :: Python
|
|
14
12
|
Classifier: Programming Language :: Python :: 3
|
|
15
13
|
Classifier: Programming Language :: Python :: 3 :: Only
|
|
16
|
-
Classifier: Programming Language :: Python :: 3.9
|
|
17
14
|
Classifier: Programming Language :: Python :: 3.10
|
|
18
15
|
Classifier: Programming Language :: Python :: 3.11
|
|
19
16
|
Classifier: Programming Language :: Python :: 3.12
|
|
@@ -22,10 +19,11 @@ Classifier: Programming Language :: Python :: 3.14
|
|
|
22
19
|
Classifier: Topic :: Software Development
|
|
23
20
|
Classifier: Topic :: Software Development :: Libraries
|
|
24
21
|
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
25
|
-
Classifier: Typing :: Typed
|
|
26
22
|
Classifier: Topic :: Utilities
|
|
27
|
-
|
|
28
|
-
Requires-
|
|
23
|
+
Classifier: Typing :: Typed
|
|
24
|
+
Requires-Python: >=3.10
|
|
25
|
+
Requires-Dist: pyyaml<7.0.0,>=6.0.3
|
|
26
|
+
Requires-Dist: rich<16.0.0,>=15.0.0
|
|
29
27
|
Description-Content-Type: text/markdown
|
|
30
28
|
|
|
31
29
|
# rich-objects
|
|
@@ -37,7 +35,7 @@ This is a small set of tools to help provide easy to use, flexible tools for dis
|
|
|
37
35
|
The project has been published to PyPi, so you should be able to install it with something like one of the following (depending on how you do Python package management):
|
|
38
36
|
```terminal
|
|
39
37
|
% pip install rich-objects
|
|
40
|
-
%
|
|
38
|
+
% uv add rich-objects
|
|
41
39
|
```
|
|
42
40
|
|
|
43
41
|
The sections below provide a brief description with links to more examples and details.
|
|
@@ -58,15 +56,22 @@ Here are some of the lower level elements:
|
|
|
58
56
|
|
|
59
57
|
## Examples
|
|
60
58
|
|
|
61
|
-
In general, this can be used in any enviroment where CLI output is used.
|
|
59
|
+
In general, this can be used in any enviroment where CLI output is used. The shell commands below assume the `example.py` file is executable (e.g. `chmod a+x example.py`).
|
|
62
60
|
|
|
63
61
|
### Typer Example
|
|
64
62
|
|
|
65
63
|
Here's a simple Python example to leverage the new code:
|
|
66
64
|
```Python
|
|
67
|
-
#!/usr/bin/env
|
|
65
|
+
#!/usr/bin/env -S uv run
|
|
66
|
+
# /// script
|
|
67
|
+
# requires-python = ">=3.9"
|
|
68
|
+
# dependencies = [
|
|
69
|
+
# "rich-objects",
|
|
70
|
+
# "typer",
|
|
71
|
+
# ]
|
|
72
|
+
# ///
|
|
68
73
|
from typer import Typer
|
|
69
|
-
from rich_objects import OutputFormat, display
|
|
74
|
+
from rich_objects import OutputFormat, OutputStyle, display
|
|
70
75
|
|
|
71
76
|
DATA = [
|
|
72
77
|
{"name": "sna", "prop1": 1, "prop B": None, "blah": "zay"},
|
|
@@ -85,7 +90,7 @@ app = Typer()
|
|
|
85
90
|
|
|
86
91
|
@app.command()
|
|
87
92
|
def print_data(
|
|
88
|
-
output_fmt: OutputFormat = OutputFormat.
|
|
93
|
+
output_fmt: OutputFormat = OutputFormat.TABLE,
|
|
89
94
|
output_style: OutputStyle = OutputStyle.ALL,
|
|
90
95
|
indent: int = 2,
|
|
91
96
|
):
|
|
@@ -147,5 +152,11 @@ Found 3 items
|
|
|
147
152
|
|
|
148
153
|
## Contributing
|
|
149
154
|
|
|
150
|
-
This project
|
|
155
|
+
This project uses [uv](https://docs.astral.sh/uv/) for packaging and development:
|
|
156
|
+
|
|
157
|
+
```terminal
|
|
158
|
+
uv sync
|
|
159
|
+
make lint test
|
|
160
|
+
```
|
|
151
161
|
|
|
162
|
+
If you have any suggestions, please email Rick directly (rickwporter@gmail.com).
|
|
@@ -7,7 +7,7 @@ This is a small set of tools to help provide easy to use, flexible tools for dis
|
|
|
7
7
|
The project has been published to PyPi, so you should be able to install it with something like one of the following (depending on how you do Python package management):
|
|
8
8
|
```terminal
|
|
9
9
|
% pip install rich-objects
|
|
10
|
-
%
|
|
10
|
+
% uv add rich-objects
|
|
11
11
|
```
|
|
12
12
|
|
|
13
13
|
The sections below provide a brief description with links to more examples and details.
|
|
@@ -28,15 +28,22 @@ Here are some of the lower level elements:
|
|
|
28
28
|
|
|
29
29
|
## Examples
|
|
30
30
|
|
|
31
|
-
In general, this can be used in any enviroment where CLI output is used.
|
|
31
|
+
In general, this can be used in any enviroment where CLI output is used. The shell commands below assume the `example.py` file is executable (e.g. `chmod a+x example.py`).
|
|
32
32
|
|
|
33
33
|
### Typer Example
|
|
34
34
|
|
|
35
35
|
Here's a simple Python example to leverage the new code:
|
|
36
36
|
```Python
|
|
37
|
-
#!/usr/bin/env
|
|
37
|
+
#!/usr/bin/env -S uv run
|
|
38
|
+
# /// script
|
|
39
|
+
# requires-python = ">=3.9"
|
|
40
|
+
# dependencies = [
|
|
41
|
+
# "rich-objects",
|
|
42
|
+
# "typer",
|
|
43
|
+
# ]
|
|
44
|
+
# ///
|
|
38
45
|
from typer import Typer
|
|
39
|
-
from rich_objects import OutputFormat, display
|
|
46
|
+
from rich_objects import OutputFormat, OutputStyle, display
|
|
40
47
|
|
|
41
48
|
DATA = [
|
|
42
49
|
{"name": "sna", "prop1": 1, "prop B": None, "blah": "zay"},
|
|
@@ -55,7 +62,7 @@ app = Typer()
|
|
|
55
62
|
|
|
56
63
|
@app.command()
|
|
57
64
|
def print_data(
|
|
58
|
-
output_fmt: OutputFormat = OutputFormat.
|
|
65
|
+
output_fmt: OutputFormat = OutputFormat.TABLE,
|
|
59
66
|
output_style: OutputStyle = OutputStyle.ALL,
|
|
60
67
|
indent: int = 2,
|
|
61
68
|
):
|
|
@@ -117,4 +124,11 @@ Found 3 items
|
|
|
117
124
|
|
|
118
125
|
## Contributing
|
|
119
126
|
|
|
120
|
-
This project
|
|
127
|
+
This project uses [uv](https://docs.astral.sh/uv/) for packaging and development:
|
|
128
|
+
|
|
129
|
+
```terminal
|
|
130
|
+
uv sync
|
|
131
|
+
make lint test
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
If you have any suggestions, please email Rick directly (rickwporter@gmail.com).
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
[project]
|
|
2
2
|
name = "rich-objects"
|
|
3
|
-
version = "0.
|
|
3
|
+
version = "0.3.0"
|
|
4
4
|
description = "Tools to rich print complex objects (e.g. JSON responses)"
|
|
5
5
|
authors = [
|
|
6
6
|
{name = "Rick Porter",email = "rickwporter@gmail.com"}
|
|
7
7
|
]
|
|
8
8
|
readme = "README.md"
|
|
9
|
-
requires-python = ">=3.
|
|
9
|
+
requires-python = ">=3.10"
|
|
10
10
|
dependencies = [
|
|
11
|
-
"rich (>=
|
|
11
|
+
"rich (>=15.0.0,<16.0.0)",
|
|
12
12
|
"pyyaml (>=6.0.3,<7.0.0)"
|
|
13
13
|
]
|
|
14
14
|
classifiers = [
|
|
@@ -19,7 +19,6 @@ classifiers = [
|
|
|
19
19
|
"Programming Language :: Python",
|
|
20
20
|
"Programming Language :: Python :: 3",
|
|
21
21
|
"Programming Language :: Python :: 3 :: Only",
|
|
22
|
-
"Programming Language :: Python :: 3.9",
|
|
23
22
|
"Programming Language :: Python :: 3.10",
|
|
24
23
|
"Programming Language :: Python :: 3.11",
|
|
25
24
|
"Programming Language :: Python :: 3.12",
|
|
@@ -34,13 +33,15 @@ classifiers = [
|
|
|
34
33
|
|
|
35
34
|
|
|
36
35
|
[build-system]
|
|
37
|
-
requires = ["
|
|
38
|
-
build-backend = "
|
|
36
|
+
requires = ["hatchling"]
|
|
37
|
+
build-backend = "hatchling.build"
|
|
39
38
|
|
|
40
|
-
[
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
39
|
+
[dependency-groups]
|
|
40
|
+
dev = [
|
|
41
|
+
"ruff>=0.16.8,<0.17.0",
|
|
42
|
+
"pytest>=9.1.1,<10.0.0",
|
|
43
|
+
"coverage>=7.16.1,<8.0.0",
|
|
44
|
+
]
|
|
44
45
|
|
|
45
46
|
[tool.ruff]
|
|
46
47
|
line-length = 120
|
|
@@ -232,14 +232,25 @@ def rich_table_factory(
|
|
|
232
232
|
|
|
233
233
|
def display(
|
|
234
234
|
obj: Any,
|
|
235
|
-
fmt: OutputFormat,
|
|
236
|
-
style: OutputStyle,
|
|
235
|
+
fmt: OutputFormat = OutputFormat.TABLE,
|
|
236
|
+
style: OutputStyle = OutputStyle.ALL,
|
|
237
237
|
indent: int = 2,
|
|
238
238
|
columns: Optional[list[str]] = None,
|
|
239
239
|
console: Optional[Console] = None,
|
|
240
240
|
config: Optional[TableConfig] = None,
|
|
241
241
|
) -> None:
|
|
242
|
-
"""Display the data provided in obj, according to the formating arguments.
|
|
242
|
+
"""Display the data provided in obj, according to the formating arguments.
|
|
243
|
+
|
|
244
|
+
Arguments:
|
|
245
|
+
obj: object to be displayed
|
|
246
|
+
fmt: controls the json/table/yaml output formatting (default=table)
|
|
247
|
+
style: controls color/bold highlighting (default=all)
|
|
248
|
+
indent: conroles number of indented spaces in json/yaml output (default=2)
|
|
249
|
+
columns: used to control columns for a list of items, use a '*' as last argument to get remaining data.
|
|
250
|
+
console: overrides default rich.Console, so you can provide additional highlighers.
|
|
251
|
+
config: controls table parameters (e.g. labels, max-widths, row properties)
|
|
252
|
+
|
|
253
|
+
"""
|
|
243
254
|
no_color = style != OutputStyle.ALL
|
|
244
255
|
highlight = style != OutputStyle.NONE
|
|
245
256
|
console = console or console_factory(no_color=no_color, highlight=highlight)
|
|
File without changes
|