graphxr-database-proxy 1.0.2__tar.gz → 1.0.3__tar.gz

{graphxr_database_proxy-1.0.2 → graphxr_database_proxy-1.0.3}/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 Kineviz
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+MIT License
+
+Copyright (c) 2025 Kineviz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

{graphxr_database_proxy-1.0.2 → graphxr_database_proxy-1.0.3}/MANIFEST.in

@@ -1,28 +1,28 @@
-# 包含静态文件
-recursive-include src/graphxr_database_proxy/static *
-
-# 包含文档文件
-include README.md
-include LICENSE
-include *.md
-
-# 包含配置文件
-include pyproject.toml
-include requirements.txt
-
-# 包含示例和文档
-recursive-include examples *.py
-recursive-include doc *.md
-
-# 排除不需要的文件
-global-exclude *.pyc
-global-exclude *.pyo
-global-exclude *~
-global-exclude .git*
-global-exclude .env*
-prune .venv
-prune __pycache__
-prune .pytest_cache
-prune node_modules
-prune frontend/node_modules
+# 包含静态文件
+recursive-include src/graphxr_database_proxy/static *
+
+# 包含文档文件
+include README.md
+include LICENSE
+include *.md
+
+# 包含配置文件
+include pyproject.toml
+include requirements.txt
+
+# 包含示例和文档
+recursive-include examples *.py
+recursive-include doc *.md
+
+# 排除不需要的文件
+global-exclude *.pyc
+global-exclude *.pyo
+global-exclude *~
+global-exclude .git*
+global-exclude .env*
+prune .venv
+prune __pycache__
+prune .pytest_cache
+prune node_modules
+prune frontend/node_modules
 prune frontend/.webpack-cache

{graphxr_database_proxy-1.0.2/src/graphxr_database_proxy.egg-info → graphxr_database_proxy-1.0.3}/PKG-INFO

@@ -1,208 +1,209 @@
-Metadata-Version: 2.4
-Name: graphxr-database-proxy
-Version: 1.0.2
-Summary: GraphXR Database Proxy - Secure middleware for connecting GraphXR to databases
-Author-email: Sean Li <sean@kineviz.com>, Kineviz <support@kineviz.com>
-License-Expression: MIT
-Project-URL: Homepage, https://github.com/Kineviz/graphxr-database-proxy
-Project-URL: Documentation, https://docs.kineviz.com/graphxr-database-proxy
-Project-URL: Repository, https://github.com/Kineviz/graphxr-database-proxy
-Project-URL: Bug Tracker, https://github.com/Kineviz/graphxr-database-proxy/issues
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: fastapi>=0.104.0
-Requires-Dist: uvicorn[standard]>=0.24.0
-Requires-Dist: pydantic>=2.0.0
-Requires-Dist: python-multipart>=0.0.6
-Requires-Dist: google-cloud-spanner>=3.40.0
-Requires-Dist: google-auth-oauthlib>=1.0.0
-Requires-Dist: google-auth>=2.0.0
-Requires-Dist: aiofiles>=23.0.0
-Requires-Dist: pyyaml>=6.0
-Provides-Extra: ui
-Requires-Dist: aiofiles>=23.0.0; extra == "ui"
-Provides-Extra: dev
-Requires-Dist: pytest>=7.0.0; extra == "dev"
-Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
-Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
-Requires-Dist: black>=23.0.0; extra == "dev"
-Requires-Dist: isort>=5.12.0; extra == "dev"
-Requires-Dist: flake8>=6.0.0; extra == "dev"
-Requires-Dist: mypy>=1.5.0; extra == "dev"
-Requires-Dist: pre-commit>=3.0.0; extra == "dev"
-Provides-Extra: all
-Requires-Dist: graphxr-database-proxy[dev,ui]; extra == "all"
-Dynamic: license-file
-
-# GraphXR Database Proxy
-
-[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
-[![Python Version](https://img.shields.io/badge/python-3.8+-blue.svg)](https://python.org)
-[![FastAPI](https://img.shields.io/badge/FastAPI-0.104+-green.svg)](https://fastapi.tiangolo.com)
-
-> **Language**: [English](https://github.com/Kineviz/graphxr-database-proxy/blob/main/readme.md) | [中文](https://github.com/Kineviz/graphxr-database-proxy/blob/main/readme.zh.md)
-
-A secure middleware that connects [GraphXR](https://www.kineviz.com/graphxr) to various backend databases with zero trust architecture.
-
-## Features
-
-- **Zero Trust Security**: Strict authentication and authorization at the proxy layer
-- **Direct Browser Connectivity**: REST/GraphQL APIs for efficient data access
-- **Multi-Database Support**: Spanner Graph, Neo4j, and more
-- **Open Source**: Fully auditable and customizable
-- **Pure Python**: Easy to deploy and maintain
-
-## ⚡ Quick Start for Spanner Graph
-
-1. Run the following commands to start graphxr-database-proxy (requires [uv](https://docs.astral.sh/uv/), [node.js](https://nodejs.org/en/download/))
-
-```
-git clone https://github.com/Kineviz/graphxr-database-proxy.git
-cd graphxr-database-proxy
-uv venv
-source .venv/bin/activate # or .venv/bin/activate on Windows
-uv pip install -e ".[ui]"
-uv pip install -r requirements.txt
-cd frontend && npm install && npm run build && cd -
-graphxr-proxy --ui 
-```
-
-2. Visit http://localhost:9080/
-3. Click "Create New Project"
-4. Project Name: "Test"
-5. Database Type: "Google Cloud Spanner"
-6. Authentication Type: "Service Account"
-7. Upload the credential file you exported from GCP Console or gcloud CLI. [Export Instructions](https://github.com/Kineviz/try-graphxr-spannergraph#)
-8. Select "Instance ID" e.g. "demo"
-9. Select "Database ID" e.g. "cymbal"
-10. Select "Property Graph" e.g. "ECommerceGraph"
-11. Click "Create"
-12. For the new project, under Actions, copy the API URL. e.g. "http://localhost:9080/api/spanner/Test"
-13. Go back to GraphXR's Create Project wizard and paste the API URL into GraphXR for a project with a "Database Proxy" database type.
-
-## Other ways to start graphxr-database-proxy
-
-### Install
-
-```bash
-# Install from PyPI
-pip install graphxr-database-proxy[ui]
-
-# Or from source
-git clone https://github.com/Kineviz/graphxr-database-proxy.git
-cd graphxr-database-proxy
-uv venv
-source .venv/bin/activate # or .venv/bin/activate on Windows
-uv pip install -e ".[ui]"
-uv pip install -r requirements.txt
-cd frontend && npm install && npm run build && cd -
-pip install -e .[ui]
-```
-
-### Configure & Run
-
-**Option 1: Web UI (Recommended)**
-```bash
-graphxr-proxy --ui
-```
-> Open http://localhost:9080/admin for configuration
-
-**Option 2: Python Code with Service Account JSON**
-```python
-from graphxr_database_proxy import DatabaseProxy
-
-proxy = DatabaseProxy()
-
-service_account_json = {
-    "type": "service_account",
-    "project_id": "your-gcp-project-id",
-    "private_key": "-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\\n",
-    "client_email": "your-service-account@your-gcp-project-id.iam.gserviceaccount.com",
-    ...
-}
-
-project_id = proxy.add_project(
-    project_name="project_name",
-    database_type="spanner",
-    project_id="gcp-project-id", 
-    instance_id="spanner-instance-id",
-    database_id="spanner-database-id",
-    credentials=service_account_json,  
-    graph_name="graph_name"  # Optional
-)
-
-proxy.start(
-    host="0.0.0.0",     
-    port=9080,          
-    show_apis=True     
-)
-```
-
-**Option 3: Python Code with Google Cloud ADC**
-> Your should have set up Google Application Default Credentials (ADC) on the machine running the proxy. See [Google Cloud ADC Documentation](https://cloud.google.com/docs/authentication/production#automatically).
-
-```python
-from graphxr_database_proxy import DatabaseProxy
-proxy = DatabaseProxy()
-
-google_adc_credentials={
-    "type": "google_ADC"
-},  
- 
-project_id = proxy.add_project(
-    project_name="project_name",
-    database_type="spanner",
-    project_id="gcp-project-id", 
-    instance_id="spanner-instance-id",
-    database_id="spanner-database-id",
-    credentials=google_adc_credentials,  
-    graph_name="graph_name"  # Optional
-)
-
-proxy.start(
-    host="0.0.0.0",     
-    port=9080,          
-    show_apis=True     
-)
-```
-
-## 🐳 Docker
-
-```bash
-docker run -d -p 9080:9080 \
---name graphxr-database-proxy \
--v ${HOME}/graphxr-database-proxy/config:/app/config \
-kineviz/graphxr-database-proxy:latest
-```
-> You can visit http://localhost:9080/admin for configuration after starting the container.
-
-
-
-## 🤝 Contributing
-
-1. Fork the repository
-2. Create a feature branch (`git checkout -b feature/amazing-feature`)
-3. Commit your changes (`git commit -m 'Add some amazing feature'`)
-4. Push to the branch (`git push origin feature/amazing-feature`)
-5. Open a Pull Request
-
-## 📄 License
-
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
-
-## 🆘 Support
-
-- 🐛 [Issue Tracker](https://github.com/Kineviz/graphxr-database-proxy/issues)
-- 📧 Email: support@kineviz.com
-
----
-
-**Built with ❤️ by [Kineviz](https://www.kineviz.com)**
+Metadata-Version: 2.4
+Name: graphxr-database-proxy
+Version: 1.0.3
+Summary: GraphXR Database Proxy - Secure middleware for connecting GraphXR to databases
+Author-email: Sean Li <sean@kineviz.com>, Kineviz <support@kineviz.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/Kineviz/graphxr-database-proxy
+Project-URL: Documentation, https://docs.kineviz.com/graphxr-database-proxy
+Project-URL: Repository, https://github.com/Kineviz/graphxr-database-proxy
+Project-URL: Bug Tracker, https://github.com/Kineviz/graphxr-database-proxy/issues
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastapi>=0.104.0
+Requires-Dist: uvicorn[standard]>=0.24.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: python-multipart>=0.0.6
+Requires-Dist: google-cloud-spanner>=3.40.0
+Requires-Dist: google-cloud-resource-manager>=1.10.0
+Requires-Dist: google-auth-oauthlib>=1.0.0
+Requires-Dist: google-auth>=2.0.0
+Requires-Dist: aiofiles>=23.0.0
+Requires-Dist: pyyaml>=6.0
+Provides-Extra: ui
+Requires-Dist: aiofiles>=23.0.0; extra == "ui"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: isort>=5.12.0; extra == "dev"
+Requires-Dist: flake8>=6.0.0; extra == "dev"
+Requires-Dist: mypy>=1.5.0; extra == "dev"
+Requires-Dist: pre-commit>=3.0.0; extra == "dev"
+Provides-Extra: all
+Requires-Dist: graphxr-database-proxy[dev,ui]; extra == "all"
+Dynamic: license-file
+
+# GraphXR Database Proxy
+
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+[![Python Version](https://img.shields.io/badge/python-3.8+-blue.svg)](https://python.org)
+[![FastAPI](https://img.shields.io/badge/FastAPI-0.104+-green.svg)](https://fastapi.tiangolo.com)
+
+> **Language**: [English](https://github.com/Kineviz/graphxr-database-proxy/blob/main/readme.md) | [中文](https://github.com/Kineviz/graphxr-database-proxy/blob/main/readme.zh.md)
+
+A secure middleware that connects [GraphXR](https://www.kineviz.com/graphxr) to various backend databases with zero trust architecture.
+
+## Features
+
+- **Zero Trust Security**: Strict authentication and authorization at the proxy layer
+- **Direct Browser Connectivity**: REST/GraphQL APIs for efficient data access
+- **Multi-Database Support**: Spanner Graph, Neo4j, and more
+- **Open Source**: Fully auditable and customizable
+- **Pure Python**: Easy to deploy and maintain
+
+## ⚡ Quick Start for Spanner Graph
+
+1. Run the following commands to start graphxr-database-proxy (requires [uv](https://docs.astral.sh/uv/), [node.js](https://nodejs.org/en/download/))
+
+```
+git clone https://github.com/Kineviz/graphxr-database-proxy.git
+cd graphxr-database-proxy
+uv venv
+source .venv/bin/activate # or .venv/bin/activate on Windows
+uv pip install -e ".[ui]"
+uv pip install -r requirements.txt
+cd frontend && npm install && npm run build && cd -
+graphxr-proxy --ui 
+```
+
+2. Visit http://localhost:9080/
+3. Click "Create New Project"
+4. Project Name: "Test"
+5. Database Type: "Google Cloud Spanner"
+6. Authentication Type: "Service Account"
+7. Upload the credential file you exported from GCP Console or gcloud CLI. [Export Instructions](https://github.com/Kineviz/try-graphxr-spannergraph#)
+8. Select "Instance ID" e.g. "demo"
+9. Select "Database ID" e.g. "cymbal"
+10. Select "Property Graph" e.g. "ECommerceGraph"
+11. Click "Create"
+12. For the new project, under Actions, copy the API URL. e.g. "http://localhost:9080/api/spanner/Test"
+13. Go back to GraphXR's Create Project wizard and paste the API URL into GraphXR for a project with a "Database Proxy" database type.
+
+## Other ways to start graphxr-database-proxy
+
+### Install
+
+```bash
+# Install from PyPI
+pip install graphxr-database-proxy[ui]
+
+# Or from source
+git clone https://github.com/Kineviz/graphxr-database-proxy.git
+cd graphxr-database-proxy
+uv venv
+source .venv/bin/activate # or .venv/bin/activate on Windows
+uv pip install -e ".[ui]"
+uv pip install -r requirements.txt
+cd frontend && npm install && npm run build && cd -
+pip install -e .[ui]
+```
+
+### Configure & Run
+
+**Option 1: Web UI (Recommended)**
+```bash
+graphxr-proxy --ui
+```
+> Open http://localhost:9080/admin for configuration
+
+**Option 2: Python Code with Service Account JSON**
+```python
+from graphxr_database_proxy import DatabaseProxy
+
+proxy = DatabaseProxy()
+
+service_account_json = {
+    "type": "service_account",
+    "project_id": "your-gcp-project-id",
+    "private_key": "-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\\n",
+    "client_email": "your-service-account@your-gcp-project-id.iam.gserviceaccount.com",
+    ...
+}
+
+project_id = proxy.add_project(
+    project_name="project_name",
+    database_type="spanner",
+    project_id="gcp-project-id", 
+    instance_id="spanner-instance-id",
+    database_id="spanner-database-id",
+    credentials=service_account_json,  
+    graph_name="graph_name"  # Optional
+)
+
+proxy.start(
+    host="0.0.0.0",     
+    port=9080,          
+    show_apis=True     
+)
+```
+
+**Option 3: Python Code with Google Cloud ADC**
+> Your should have set up Google Application Default Credentials (ADC) on the machine running the proxy. See [Google Cloud ADC Documentation](https://cloud.google.com/docs/authentication/production#automatically).
+
+```python
+from graphxr_database_proxy import DatabaseProxy
+proxy = DatabaseProxy()
+
+google_adc_credentials={
+    "type": "google_ADC"
+},  
+ 
+project_id = proxy.add_project(
+    project_name="project_name",
+    database_type="spanner",
+    project_id="gcp-project-id", 
+    instance_id="spanner-instance-id",
+    database_id="spanner-database-id",
+    credentials=google_adc_credentials,  
+    graph_name="graph_name"  # Optional
+)
+
+proxy.start(
+    host="0.0.0.0",     
+    port=9080,          
+    show_apis=True     
+)
+```
+
+## 🐳 Docker
+
+```bash
+docker run -d -p 9080:9080 \
+--name graphxr-database-proxy \
+-v ${HOME}/graphxr-database-proxy/config:/app/config \
+kineviz/graphxr-database-proxy:latest
+```
+> You can visit http://localhost:9080/admin for configuration after starting the container.
+
+
+
+## 🤝 Contributing
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## 📄 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## 🆘 Support
+
+- 🐛 [Issue Tracker](https://github.com/Kineviz/graphxr-database-proxy/issues)
+- 📧 Email: support@kineviz.com
+
+---
+
+**Built with ❤️ by [Kineviz](https://www.kineviz.com)**