polygres-cli 0.1.0__tar.gz

polygres_cli-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,40 @@
+name: ci
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+
+      - name: Install package and development dependencies
+        run: python -m pip install -e ".[dev]"
+
+      - name: Run tests
+        run: pytest
+
+      - name: Run lint
+        run: ruff check .
+
+      - name: Build package
+        run: python -m build

polygres_cli-0.1.0/.github/workflows/publish-python-cli.yml

@@ -0,0 +1,99 @@
+name: Publish Python CLI
+
+on:
+  workflow_dispatch:
+    inputs:
+      publish_target:
+        description: Package index to publish to
+        required: true
+        type: choice
+        options:
+          - testpypi
+          - none
+        default: testpypi
+  push:
+    tags:
+      - "python-cli-v*"
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Validate and build CLI
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+          cache: pip
+
+      - name: Install package and release dependencies
+        run: python -m pip install -e ".[dev]" twine
+
+      - name: Run lint
+        run: python -m ruff check .
+
+      - name: Run tests
+        run: python -m pytest
+
+      - name: Build CLI distribution
+        run: |
+          rm -rf dist
+          python -m build
+          python -m twine check dist/*
+
+      - name: Upload CLI distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-cli-dist
+          path: dist/*
+          if-no-files-found: error
+
+  publish-testpypi:
+    name: Publish CLI to TestPyPI
+    needs: build
+    if: github.event_name == 'workflow_dispatch' && inputs.publish_target == 'testpypi'
+    runs-on: ubuntu-latest
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/project/polygres-cli/
+    permissions:
+      id-token: write
+    steps:
+      - name: Download CLI distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: python-cli-dist
+          path: dist/
+
+      - name: Publish to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+  publish-pypi:
+    name: Publish CLI to PyPI
+    needs: build
+    if: startsWith(github.ref, 'refs/tags/python-cli-v')
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/polygres-cli/
+    permissions:
+      id-token: write
+    steps:
+      - name: Download CLI distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: python-cli-dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

polygres_cli-0.1.0/.gitignore

@@ -0,0 +1,23 @@
+# Environments
+.env
+.venv
+env/
+venv/
+
+# Python and package output
+__pycache__/
+*.py[cod]
+*.egg-info/
+build/
+dist/
+
+# Test and tooling caches
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+
+# Editor and operating system files
+.DS_Store
+.idea/
+.vscode/
+*.swp

polygres_cli-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,31 @@
+# Contributing
+
+## Development setup
+
+Use Python 3.10 or newer.
+
+```bash
+python3 -m venv .venv
+. .venv/bin/activate
+pip install -e ".[dev]"
+```
+
+## Checks
+
+```bash
+pytest
+ruff check .
+python -m build
+```
+
+## Publishing
+
+Publishing uses GitHub Actions Trusted Publishing. Validate first through
+TestPyPI, then publish a matching `python-cli-vX.Y.Z` tag from the public CLI
+repository. Do not add PyPI API tokens to GitHub secrets.
+
+## Scope
+
+This repository contains the public command-line client. Keep control-plane
+authentication, configuration, command behavior, and CLI documentation here.
+Runtime API retrieval models and library APIs belong in `polygres-sdk`.

polygres_cli-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.

polygres_cli-0.1.0/PKG-INFO

@@ -0,0 +1,95 @@
+Metadata-Version: 2.4
+Name: polygres-cli
+Version: 0.1.0
+Summary: Command-line interface for Polygres
+Project-URL: Homepage, https://polygres.com
+Project-URL: Documentation, https://docs.evokoa.com/polygres
+Project-URL: Repository, https://github.com/Evokoa/polygres-cli
+Project-URL: Issues, https://github.com/Evokoa/polygres-cli/issues
+Project-URL: Support, https://polygres.com
+Author: Polygres
+Maintainer-email: Polygres <support@evokoa.com>
+License: Apache-2.0
+License-File: LICENSE
+Keywords: cli,polygres,postgres,postgresql
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.28.1
+Provides-Extra: dev
+Requires-Dist: build>=1.2.2; extra == 'dev'
+Requires-Dist: hatchling>=1.26.3; extra == 'dev'
+Requires-Dist: pytest>=8.3.4; extra == 'dev'
+Requires-Dist: respx>=0.21.1; extra == 'dev'
+Requires-Dist: ruff>=0.8.4; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Polygres CLI
+
+The Polygres CLI manages Polygres projects from the terminal. It authenticates
+with the control plane and supports project setup, imports, migrations, and
+retrieval configuration. It does not expose database passwords.
+
+## Install
+
+```bash
+pip install polygres-cli
+```
+
+For an isolated global installation:
+
+```bash
+pipx install polygres-cli
+```
+
+The command remains `polygres`:
+
+```bash
+polygres login
+polygres whoami
+polygres projects list
+polygres projects use <project-id-or-exact-name>
+polygres env
+polygres ready
+```
+
+`polygres login` opens the Polygres dashboard for approval and prints a URL for
+headless terminals. Credentials are stored at
+`~/.config/polygres/config.json` with owner-only permissions on POSIX systems.
+Run `polygres logout` to revoke the refresh token and remove local credentials.
+
+Common project operations:
+
+```bash
+polygres import csv ./documents.csv --table documents --wait
+polygres migrations apply --file ./001_create_documents.sql
+polygres graph discover --json > graph.json
+polygres graph config apply --file graph.json
+polygres vector configs list
+polygres text configs list
+```
+
+Run `polygres --help` for the full command reference. Exit codes distinguish
+validation (`2`), authentication (`3`), permission (`4`), not found (`5`),
+conflict (`6`), rate limiting (`7`), remote availability (`8`), and missing
+local tools such as `psql` (`9`).
+
+## Relationship to the Python SDK
+
+The CLI is distributed separately from the Python SDK. Install `polygres-sdk` when
+your application needs Runtime API retrieval methods, and install
+`polygres-cli` when you need the terminal command. The CLI has its own
+control-plane client and does not require the SDK.
+
+Users of the former combined `polygres` package should install `polygres-cli`
+and `polygres-sdk` separately.

polygres_cli-0.1.0/README.md

@@ -0,0 +1,59 @@
+# Polygres CLI
+
+The Polygres CLI manages Polygres projects from the terminal. It authenticates
+with the control plane and supports project setup, imports, migrations, and
+retrieval configuration. It does not expose database passwords.
+
+## Install
+
+```bash
+pip install polygres-cli
+```
+
+For an isolated global installation:
+
+```bash
+pipx install polygres-cli
+```
+
+The command remains `polygres`:
+
+```bash
+polygres login
+polygres whoami
+polygres projects list
+polygres projects use <project-id-or-exact-name>
+polygres env
+polygres ready
+```
+
+`polygres login` opens the Polygres dashboard for approval and prints a URL for
+headless terminals. Credentials are stored at
+`~/.config/polygres/config.json` with owner-only permissions on POSIX systems.
+Run `polygres logout` to revoke the refresh token and remove local credentials.
+
+Common project operations:
+
+```bash
+polygres import csv ./documents.csv --table documents --wait
+polygres migrations apply --file ./001_create_documents.sql
+polygres graph discover --json > graph.json
+polygres graph config apply --file graph.json
+polygres vector configs list
+polygres text configs list
+```
+
+Run `polygres --help` for the full command reference. Exit codes distinguish
+validation (`2`), authentication (`3`), permission (`4`), not found (`5`),
+conflict (`6`), rate limiting (`7`), remote availability (`8`), and missing
+local tools such as `psql` (`9`).
+
+## Relationship to the Python SDK
+
+The CLI is distributed separately from the Python SDK. Install `polygres-sdk` when
+your application needs Runtime API retrieval methods, and install
+`polygres-cli` when you need the terminal command. The CLI has its own
+control-plane client and does not require the SDK.
+
+Users of the former combined `polygres` package should install `polygres-cli`
+and `polygres-sdk` separately.

polygres_cli-0.1.0/SECURITY.md

@@ -0,0 +1,12 @@
+# Security Policy
+
+## Reporting a vulnerability
+
+Report suspected vulnerabilities privately by emailing support@evokoa.com.
+Include the affected CLI version, a clear description, reproduction steps, and
+known impact. Do not open a public issue for a security vulnerability.
+
+## Supported versions
+
+Security fixes target the latest released Polygres CLI version. The CLI is in
+alpha, so users should upgrade promptly when a security release is published.

polygres_cli-0.1.0/pyproject.toml

@@ -0,0 +1,69 @@
+[project]
+name = "polygres-cli"
+version = "0.1.0"
+description = "Command-line interface for Polygres"
+readme = "README.md"
+requires-python = ">=3.10"
+license = { text = "Apache-2.0" }
+authors = [
+  { name = "Polygres" }
+]
+maintainers = [
+  { name = "Polygres", email = "support@evokoa.com" }
+]
+keywords = ["polygres", "postgres", "postgresql", "cli"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Environment :: Console",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: Apache Software License",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14"
+]
+dependencies = ["httpx>=0.28.1"]
+
+[project.scripts]
+polygres = "polygres_cli.cli:main"
+
+[project.urls]
+Homepage = "https://polygres.com"
+Documentation = "https://docs.evokoa.com/polygres"
+Repository = "https://github.com/Evokoa/polygres-cli"
+Issues = "https://github.com/Evokoa/polygres-cli/issues"
+Support = "https://polygres.com"
+
+[project.optional-dependencies]
+dev = [
+  "build>=1.2.2",
+  "hatchling>=1.26.3",
+  "pytest>=8.3.4",
+  "respx>=0.21.1",
+  "ruff>=0.8.4"
+]
+
+[build-system]
+requires = ["hatchling>=1.26.3"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/polygres_cli"]
+
+[tool.pytest.ini_options]
+addopts = "-q"
+testpaths = ["tests"]
+markers = [
+  "heavy: opt-in tests that require an installed wheel or live staging services",
+]
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B"]

polygres_cli-0.1.0/src/polygres_cli/__init__.py

@@ -0,0 +1 @@
+"""Polygres command-line client package."""