shirabe-profiling 0.1.0__tar.gz

shirabe_profiling-0.1.0/.env.example

@@ -0,0 +1,2 @@
+UV_PUBLISH_TOKEN=
+UV_PUBLISH_TEST_TOKEN=

shirabe_profiling-0.1.0/.envrc

@@ -0,0 +1,4 @@
+# SPDX-FileCopyrightText: Copyright © 2026 shuretokki
+# SPDX-License-Identifier: Apache-2.0
+
+use flake

shirabe_profiling-0.1.0/.github/CODEOWNERS

@@ -0,0 +1,4 @@
+# SPDX-FileCopyrightText: Copyright © 2026 shuretokki
+# SPDX-License-Identifier: Apache-2.0
+
+* @shuretokki

shirabe_profiling-0.1.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,31 @@
+---
+# SPDX-FileCopyrightText: Copyright © 2026 shuretokki
+# SPDX-License-Identifier: Apache-2.0
+
+name: Bug Report
+about: Report a bug in shirabe-profiling
+labels: bug
+---
+
+## Description
+
+A clear description of the bug.
+
+## Steps to Reproduce
+
+```python
+import polars as pl
+from shirabe_profiling import ProfileReport
+
+# minimal code to reproduce
+```
+
+## Expected Behavior
+
+What you expected to happen.
+
+## Actual Behavior
+
+What actually happened. Include the full error traceback if applicable.
+
+## Environment

shirabe_profiling-0.1.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,24 @@
+---
+# SPDX-FileCopyrightText: Copyright © 2026 shuretokki
+# SPDX-License-Identifier: Apache-2.0
+
+name: Feature Request
+about: Suggest an improvement or new feature
+labels: enhancement
+---
+
+## Problem
+
+What problem does this solve? Why is it needed?
+
+## Proposed Solution
+
+How should it work? Include a code example if possible:
+
+```python
+# how you'd like to use it
+```
+
+## Alternatives Considered
+
+Any alternative approaches you've thought about.

shirabe_profiling-0.1.0/.github/pull_request_template.md

@@ -0,0 +1,22 @@
+<!--
+SPDX-FileCopyrightText: Copyright © 2026 shuretokki
+SPDX-License-Identifier: Apache-2.0
+-->
+
+## What
+
+Brief description of the change.
+
+## Why
+
+Motivation — what problem does this solve?
+
+## How
+
+Key implementation decisions (if non-obvious).
+
+## Test Plan
+
+- [ ] Existing tests pass (`pytest tests/`)
+- [ ] New tests added (if applicable)
+- [ ] Tested manually with a sample dataset

shirabe_profiling-0.1.0/.gitignore

@@ -0,0 +1,28 @@
+# SPDX-FileCopyrightText: Copyright © 2026 shuretokki
+# SPDX-License-Identifier: Apache-2.0
+
+.local/
+*.local.*
+.direnv/
+result
+__pycache__/
+*.py[cod]
+*.so
+*.egg-info/
+dist/
+build/
+.venv/
+.idea/
+.vscode/
+*.swp
+*.swo
+.DS_Store
+Thumbs.db
+.pytest_cache/
+.coverage
+htmlcov/
+.mypy_cache/
+reports/
+.ipynb_checkpoints/
+.ruff_cache/
+.env

shirabe_profiling-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

shirabe_profiling-0.1.0/.reuse/templates/template.jinja2

@@ -0,0 +1,6 @@
+{% for copyright_line in copyright_lines -%}
+{{ copyright_line }}
+{% endfor -%}
+{% for expression in spdx_expressions -%}
+SPDX-License-Identifier: {{ expression }}
+{% endfor -%}

shirabe_profiling-0.1.0/CHANGELOG.md

@@ -0,0 +1,34 @@
+<!--
+SPDX-FileCopyrightText: Copyright © 2026 shuretokki
+SPDX-License-Identifier: Apache-2.0
+-->
+
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/),
+and this project adheres to [Semantic Versioning](https://semver.org/).
+
+## [0.1.0] - 2026-10-17
+
+First release as `shirabe-profiling`. This project is a derivative work based on [dataxid-profiling](https://github.com/dataxid/dataxid-profiling) 0.4.0 (Apache-2.0).
+
+### Changed
+
+- The package is now `shirabe-profiling` and the import is `shirabe_profiling`
+- The report has a new design: a dark theme, a light theme, and a compact density for touch screens
+- The report has a new favicon
+- The report uses the official IBM Plex Sans font files
+
+### Added
+
+- Guide tab: what each alert means, when the report raises it, possible fixes, and sources
+- Feedback tab: request a feature, report a problem with a prefilled GitHub issue, and copy the reproduction details
+- Skew tabs in Column Details (`log1p`, Yeo-Johnson, and non-zero) with statistics for each version
+- Timeline chart for datetime columns
+- Alert tags and a highlighted row in Column Details for the statistic that raised the alert
+- Random and Most Missing tabs in Sample
+- Download buttons for the correlation matrices
+- A target section and leakage check when you pass `target=`
+- The full text of each license that the package uses, in `LICENSES/`, and a `license` field that lists all of them

shirabe_profiling-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,109 @@
+<!--
+SPDX-FileCopyrightText: Copyright © 2026 shuretokki
+SPDX-License-Identifier: Apache-2.0
+-->
+
+# Contributing to shirabe-profiling
+
+Thanks for your interest in contributing! Here's how to get started.
+
+## Development Setup
+
+```bash
+git clone https://github.com/shuretokki/shirabe-profiling.git
+cd shirabe-profiling
+uv sync
+```
+
+With [Nix](https://nixos.org) and [direnv](https://direnv.net), `direnv allow` loads a shell that has `uv`, `just`, and `git-cliff`.
+Run `just` to list the recipes.
+
+## Running Tests
+
+```bash
+just test
+```
+
+## Checks
+
+```bash
+just full-check     # lock file, lint, format, basedpyright, README, licenses, and pytest (aliases: check, c, fc)
+just lint --fix     # apply safe lint fixes
+just fmt-write      # add trailing commas, then format with ruff (aliases: fmt, commas)
+just fmt-check      # check the formatting and the commas without changing files
+just typecheck      # basedpyright only
+just docs-check     # the README code blocks parse, and its images and links exist
+just license-check  # every file has a license and a copyright holder (REUSE)
+```
+
+The recipes need `uv`, `git-cliff`, and `gh` on the PATH, and the Nix shell has all three.
+
+## Licenses
+
+`REUSE.toml` names the copyright holders and the license of every file, and `LICENSES/` holds one text for each license.
+When you add work from someone else, such as a font or an icon, add an annotation for its files to `REUSE.toml`.
+Then run `uvx reuse download --all` to fetch the license text, and run `just license-check` to make sure that every file is covered.
+Keep the root `LICENSE` and `LICENSES/Apache-2.0.txt` the same text, which a test checks.
+
+## Report logo
+
+The report header shows no logo for now, and the README holds the wordmark.
+To show one, copy `assets/logo/wordmark-inline.svg` to `src/shirabe_profiling/report/templates/logo-wordmark.svg`, and the header picks it up without a code change.
+That file uses `currentColor`, so the logo follows the light and the dark theme, and `.brand-wordmark` in `report.css` sets its height.
+
+## Changelog
+
+`just changelog` prints a draft for the commits since the last tag.
+It reads Conventional Commit messages (`feat:`, `fix:`, `perf:`, `chore(deps):`).
+Rewrite the draft as plain sentences and put it in `CHANGELOG.md`.
+
+## Releasing
+
+1. `just bump 0.2.0` sets the version in `pyproject.toml`, `__init__.py`, and `uv.lock`, and drafts the `CHANGELOG.md` section from the `feat`, `fix`, and `perf` commits since the last tag.
+2. Read the section and reword it if needed. `just changelog` prints a fresh draft without changing a file.
+3. Commit both as `chore(release): 0.2.0`.
+4. `just release --dry-run` checks everything and prints the release notes, and it changes nothing.
+5. `just release` does the same, asks for a `y`, then tags `v0.2.0`, pushes main and the tag, and creates the GitHub release from the changelog section.
+6. `just publish-test` and `just publish` upload to TestPyPI and PyPI.
+
+The release stops unless you are on main with a clean tree that is not behind origin.
+It also needs agreeing version files and a changelog section.
+The package must meet the PyPI upload rules, and its version must not be on PyPI yet.
+The full check must pass.
+The uploads read their tokens from a `.env` file, which git ignores.
+Copy `.env.example` to `.env` and fill in `UV_PUBLISH_TEST_TOKEN` for TestPyPI and `UV_PUBLISH_TOKEN` for PyPI.
+
+To practice a release, use a pre-release version such as `0.2.0rc1`.
+`just bump` accepts it, and `just release` marks the GitHub release as a pre-release.
+Upload it with `just publish-test` only, and install it with `pip install --pre --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple shirabe-profiling`.
+A PyPI release never changes, so delete the changelog section of the pre-release when you release the final version.
+
+## README Screenshots
+
+`just readme-images` makes the pictures in `docs/` again, so run it after a change to the report design.
+It builds a report from a synthetic dataset, crops each view with a headless browser, and needs an internet connection for the report scripts.
+It needs Chrome, Chromium, or Edge, and you can set `BROWSER` to the program if the script cannot find it.
+
+## Code Style
+
+- Line length: 99 characters
+- A call or a function signature with two or more arguments has a trailing comma, so each argument sits on its own line (`just fmt` adds the commas, `just check` fails when one is missing)
+- Type hints everywhere, `Any` only for opaque state
+- Minimal comments — code should be self-explanatory, comments explain *why*, not *what*
+- Import order: stdlib → third-party → project (enforced by `ruff`)
+- Polars-native: no NumPy/SciPy/Pandas in core logic
+
+## Pull Requests
+
+1. Fork the repo and create a feature branch
+2. Make your changes with tests
+3. Run `just check` before submitting
+4. Open a PR with a clear description of what and why
+
+## Reporting Issues
+
+Use [GitHub Issues](https://github.com/shuretokki/shirabe-profiling/issues) with the provided templates.
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the Apache License 2.0.

shirabe_profiling-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.