truthound-dashboard 1.0.0__tar.gz → 1.0.2__tar.gz

truthound_dashboard-1.0.2/LICENSE

@@ -0,0 +1,190 @@
+                                 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 the 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
+
+   Copyright 2024 Truthound Team
+
+   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.

{truthound_dashboard-1.0.0 → truthound_dashboard-1.0.2}/PKG-INFO

@@ -1,15 +1,16 @@
 Metadata-Version: 2.4
 Name: truthound-dashboard
-Version: 1.0.0
+Version: 1.0.2
 Summary: Open-source data quality dashboard - GX Cloud alternative
 Author-email: Truthound Team <team@truthound.dev>
-License-Expression: MIT
+License-Expression: Apache-2.0
+License-File: LICENSE
 Keywords: dashboard,data-quality,monitoring,truthound,validation
 Classifier: Development Status :: 3 - Alpha
 Classifier: Framework :: FastAPI
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: MIT License
+Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
@@ -41,11 +42,17 @@ Requires-Dist: pytest>=7.4.0; extra == 'dev'
 Requires-Dist: ruff>=0.1.0; extra == 'dev'
 Description-Content-Type: text/markdown
 
+<img width="300" height="300" alt="Truthound_icon" src="https://github.com/user-attachments/assets/90d9e806-8895-45ec-97dc-f8300da4d997" />
+
 # truthound-dashboard
 
+[![PyPI version](https://badge.fury.io/py/truthound-dashboard.svg)](https://pypi.org/project/truthound-dashboard/)
+[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
 A web-based data quality monitoring dashboard for [truthound](https://github.com/seadonggyun4/truthound).
 
-[Documentation](https://truthound.netlify.app) | [Live Demo](https://truthound-dashboard.netlify.app)
+[Documentation](https://truthound.netlify.app) | [Live Demo](https://truthound-dashboard.netlify.app) | [PyPI](https://pypi.org/project/truthound-dashboard/)
 
 ## Overview
 
@@ -67,7 +74,7 @@ truthound-dashboard provides a graphical interface for managing data sources, ex
 | Data Profiling | Available | Available |
 | Dark Mode | Available | Available |
 | Multi-language (en/ko) | Not Available | Available |
-| License | Commercial | MIT |
+| License | Commercial | Apache 2.0 |
 
 ## Requirements
 
@@ -215,4 +222,4 @@ Full documentation is available at [https://truthound.netlify.app](https://truth
 
 ## License
 
-This project is licensed under the MIT License.
+This project is licensed under the Apache License 2.0.

{truthound_dashboard-1.0.0 → truthound_dashboard-1.0.2}/README.md

@@ -1,8 +1,14 @@
+<img width="300" height="300" alt="Truthound_icon" src="https://github.com/user-attachments/assets/90d9e806-8895-45ec-97dc-f8300da4d997" />
+
 # truthound-dashboard
 
+[![PyPI version](https://badge.fury.io/py/truthound-dashboard.svg)](https://pypi.org/project/truthound-dashboard/)
+[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
 A web-based data quality monitoring dashboard for [truthound](https://github.com/seadonggyun4/truthound).
 
-[Documentation](https://truthound.netlify.app) | [Live Demo](https://truthound-dashboard.netlify.app)
+[Documentation](https://truthound.netlify.app) | [Live Demo](https://truthound-dashboard.netlify.app) | [PyPI](https://pypi.org/project/truthound-dashboard/)
 
 ## Overview
 
@@ -24,7 +30,7 @@ truthound-dashboard provides a graphical interface for managing data sources, ex
 | Data Profiling | Available | Available |
 | Dark Mode | Available | Available |
 | Multi-language (en/ko) | Not Available | Available |
-| License | Commercial | MIT |
+| License | Commercial | Apache 2.0 |
 
 ## Requirements
 
@@ -172,4 +178,4 @@ Full documentation is available at [https://truthound.netlify.app](https://truth
 
 ## License
 
-This project is licensed under the MIT License.
+This project is licensed under the Apache License 2.0.

{truthound_dashboard-1.0.0 → truthound_dashboard-1.0.2}/docs/api.md

@@ -1,6 +1,6 @@
 # API Reference
 
-Truthound Dashboard REST API 문서입니다.
+This document describes the Truthound Dashboard REST API.
 
 ## Base URL
 
@@ -52,13 +52,13 @@ http://localhost:8765/api/v1
 
 ### GET /health
 
-서버 상태 확인
+Check server status.
 
 **Response:**
 ```json
 {
   "status": "ok",
-  "version": "1.0.0"
+  "version": "1.0.1"
 }
 ```
 
@@ -68,7 +68,7 @@ http://localhost:8765/api/v1
 
 ### GET /sources
 
-모든 데이터 소스 목록 조회
+Retrieve all data sources.
 
 **Response:**
 ```json
@@ -90,7 +90,7 @@ http://localhost:8765/api/v1
 
 ### POST /sources
 
-새 데이터 소스 생성
+Create a new data source.
 
 **Request:**
 ```json
@@ -104,7 +104,7 @@ http://localhost:8765/api/v1
 ```
 
 **Source Types:**
-- `file` - 로컬 파일 (CSV, Parquet)
+- `file` - Local file (CSV, Parquet)
 - `postgresql` - PostgreSQL
 - `mysql` - MySQL
 - `snowflake` - Snowflake
@@ -172,11 +172,11 @@ http://localhost:8765/api/v1
 
 ### GET /sources/{id}
 
-특정 소스 조회
+Retrieve a specific source.
 
 ### PUT /sources/{id}
 
-소스 정보 수정
+Update source information.
 
 **Request:**
 ```json
@@ -188,11 +188,11 @@ http://localhost:8765/api/v1
 
 ### DELETE /sources/{id}
 
-소스 삭제
+Delete a source.
 
 ### POST /sources/{id}/test
 
-소스 연결 테스트
+Test source connection.
 
 **Response:**
 ```json
@@ -210,7 +210,7 @@ http://localhost:8765/api/v1
 
 ### GET /sources/{id}/schema
 
-소스의 학습된 스키마 조회
+Retrieve the learned schema for a source.
 
 **Response:**
 ```json
@@ -237,7 +237,7 @@ http://localhost:8765/api/v1
 
 ### PUT /sources/{id}/schema
 
-스키마 저장 (수동 편집)
+Save schema (manual edit).
 
 **Request:**
 ```json
@@ -248,9 +248,9 @@ http://localhost:8765/api/v1
 
 ### POST /sources/{id}/learn
 
-스키마 자동 생성 (th.learn)
+Generate schema automatically (th.learn).
 
-데이터를 분석하여 스키마를 자동으로 생성합니다.
+Analyzes data to automatically generate a schema.
 
 **Response:**
 ```json
@@ -286,7 +286,7 @@ http://localhost:8765/api/v1
 
 ### POST /sources/{id}/validate
 
-검증 실행 (th.check)
+Run validation (th.check).
 
 **Request:**
 ```json
@@ -298,9 +298,9 @@ http://localhost:8765/api/v1
 ```
 
 **Parameters:**
-- `validators` (optional): 실행할 검증기 목록
-- `schema_path` (optional): 사용할 스키마 파일 경로
-- `auto_schema` (optional): true이면 스키마 자동 생성 후 검증
+- `validators` (optional): List of validators to run
+- `schema_path` (optional): Path to schema file
+- `auto_schema` (optional): If true, auto-generate schema before validation
 
 **Response:**
 ```json
@@ -337,11 +337,11 @@ http://localhost:8765/api/v1
 
 ### GET /validations/{id}
 
-검증 결과 상세 조회
+Retrieve validation result details.
 
 ### GET /sources/{id}/validations
 
-소스의 검증 히스토리 조회
+Retrieve validation history for a source.
 
 **Query Parameters:**
 - `page` (default: 1)
@@ -376,7 +376,7 @@ http://localhost:8765/api/v1
 
 ### POST /sources/{id}/profile
 
-데이터 프로파일링 실행 (th.profile)
+Run data profiling (th.profile).
 
 **Response:**
 ```json
@@ -420,7 +420,7 @@ http://localhost:8765/api/v1
 
 ### GET /sources/{id}/profile
 
-가장 최근 프로파일 결과 조회
+Retrieve the most recent profile result.
 
 ---
 
@@ -428,7 +428,7 @@ http://localhost:8765/api/v1
 
 ### POST /drift/compare
 
-두 데이터셋 비교 (th.compare)
+Compare two datasets (th.compare).
 
 **Request:**
 ```json
@@ -438,7 +438,7 @@ http://localhost:8765/api/v1
 }
 ```
 
-또는:
+Or:
 ```json
 {
   "source_path": "/data/v1.csv",
@@ -477,7 +477,7 @@ http://localhost:8765/api/v1
 
 ### GET /drift/{id}
 
-드리프트 비교 결과 조회
+Retrieve drift comparison result.
 
 ---
 
@@ -485,7 +485,7 @@ http://localhost:8765/api/v1
 
 ### GET /schedules
 
-모든 스케줄 목록 조회
+Retrieve all schedules.
 
 **Response:**
 ```json
@@ -509,7 +509,7 @@ http://localhost:8765/api/v1
 
 ### POST /schedules
 
-새 스케줄 생성
+Create a new schedule.
 
 **Request:**
 ```json
@@ -522,34 +522,34 @@ http://localhost:8765/api/v1
 ```
 
 **Cron Expression Examples:**
-- `0 9 * * *` - 매일 오전 9시
-- `0 */6 * * *` - 6시간마다
-- `0 0 * * 1` - 매주 월요일 자정
-- `0 0 1 * *` - 매월 1일 자정
+- `0 9 * * *` - Daily at 9 AM
+- `0 */6 * * *` - Every 6 hours
+- `0 0 * * 1` - Every Monday at midnight
+- `0 0 1 * *` - First day of each month at midnight
 
 ### GET /schedules/{id}
 
-스케줄 상세 조회
+Retrieve schedule details.
 
 ### PUT /schedules/{id}
 
-스케줄 수정
+Update a schedule.
 
 ### DELETE /schedules/{id}
 
-스케줄 삭제
+Delete a schedule.
 
 ### POST /schedules/{id}/pause
 
-스케줄 일시정지
+Pause a schedule.
 
 ### POST /schedules/{id}/resume
 
-스케줄 재개
+Resume a schedule.
 
 ### POST /schedules/{id}/run
 
-스케줄 즉시 실행
+Run a schedule immediately.
 
 ---
 
@@ -557,7 +557,7 @@ http://localhost:8765/api/v1
 
 ### GET /notifications/channels
 
-알림 채널 목록 조회
+Retrieve notification channels.
 
 **Response:**
 ```json
@@ -578,7 +578,7 @@ http://localhost:8765/api/v1
 
 ### POST /notifications/channels
 
-새 알림 채널 생성
+Create a new notification channel.
 
 **Slack Channel:**
 ```json
@@ -624,11 +624,11 @@ http://localhost:8765/api/v1
 
 ### DELETE /notifications/channels/{id}
 
-채널 삭제
+Delete a channel.
 
 ### POST /notifications/channels/{id}/test
 
-테스트 알림 발송
+Send a test notification.
 
 **Response:**
 ```json
@@ -640,7 +640,7 @@ http://localhost:8765/api/v1
 
 ### GET /notifications/rules
 
-알림 규칙 목록 조회
+Retrieve notification rules.
 
 **Response:**
 ```json
@@ -662,7 +662,7 @@ http://localhost:8765/api/v1
 
 ### POST /notifications/rules
 
-새 알림 규칙 생성
+Create a new notification rule.
 
 **Request:**
 ```json
@@ -675,18 +675,18 @@ http://localhost:8765/api/v1
 ```
 
 **Condition Types:**
-- `validation_failed` - 검증 실패 시
-- `critical_issues` - Critical 심각도 이슈 발생 시
-- `high_issues` - High 심각도 이슈 발생 시
-- `schedule_failed` - 스케줄 실행 실패 시
+- `validation_failed` - When validation fails
+- `critical_issues` - When critical severity issues occur
+- `high_issues` - When high severity issues occur
+- `schedule_failed` - When scheduled execution fails
 
 ### DELETE /notifications/rules/{id}
 
-규칙 삭제
+Delete a rule.
 
 ### GET /notifications/logs
 
-알림 발송 로그 조회
+Retrieve notification delivery logs.
 
 **Query Parameters:**
 - `limit` (default: 50)
@@ -714,21 +714,21 @@ http://localhost:8765/api/v1
 
 | Code | Description |
 |------|-------------|
-| `SOURCE_NOT_FOUND` | 데이터 소스를 찾을 수 없음 |
-| `VALIDATION_ERROR` | 검증 실행 중 오류 발생 |
-| `CONNECTION_ERROR` | 데이터베이스 연결 실패 |
-| `SCHEDULE_ERROR` | 스케줄 작업 실패 |
-| `NOTIFICATION_ERROR` | 알림 발송 실패 |
-| `RATE_LIMIT_EXCEEDED` | 요청 한도 초과 |
-| `INTERNAL_ERROR` | 내부 서버 오류 |
+| `SOURCE_NOT_FOUND` | Data source not found |
+| `VALIDATION_ERROR` | Error during validation execution |
+| `CONNECTION_ERROR` | Database connection failed |
+| `SCHEDULE_ERROR` | Scheduled task failed |
+| `NOTIFICATION_ERROR` | Notification delivery failed |
+| `RATE_LIMIT_EXCEEDED` | Request limit exceeded |
+| `INTERNAL_ERROR` | Internal server error |
 
 ---
 
 ## Rate Limiting
 
-기본적으로 분당 120개 요청으로 제한됩니다.
+By default, requests are limited to 120 per minute.
 
-Rate limit 초과 시:
+When rate limit is exceeded:
 ```json
 {
   "success": false,
@@ -743,13 +743,13 @@ Rate limit 초과 시:
 
 ## Authentication (Optional)
 
-인증이 활성화된 경우 모든 요청에 Basic Auth 헤더가 필요합니다:
+When authentication is enabled, all API requests require Basic Auth headers:
 
 ```bash
 curl -u :password http://localhost:8765/api/v1/health
 ```
 
-환경 변수로 인증 활성화:
+Enable authentication via environment variables:
 ```bash
 TRUTHOUND_AUTH_ENABLED=true
 TRUTHOUND_AUTH_PASSWORD=your-secret-password