Skip to main content

Python implementation of the PinMe deployment CLI

Project description

PinMe Python

pinme-python is a Python implementation of the PinMe CLI. It keeps the public command surface, local config files, upload protocol, project workflow, and tracking event names aligned with the Node.js pinme CLI.

Install

pip install pinme-python

For local development:

python3 -m venv .venv
. .venv/bin/activate
pip install -e ".[dev]"

The package installs both command names:

pinme --version
pinme-python --version

Configuration

The Python CLI uses the same local state as the Node CLI:

  • auth file: ~/.pinme/auth.json
  • device id: ~/.pinme/device-id
  • upload history: ~/.pinme/upload-history.json
  • project config: pinme.toml

Environment variables match the Node implementation:

  • PINME_API_BASE
  • IPFS_API_URL
  • CAR_API_BASE
  • PINME_WEB_URL
  • PINME_CHECK_DOMAIN_PATH
  • IPFS_PREVIEW_URL
  • PROJECT_PREVIEW_URL
  • SECRET_KEY
  • PINME_PROJECT_NAME
  • FILE_SIZE_LIMIT
  • DIRECTORY_SIZE_LIMIT
  • MAX_RETRIES
  • RETRY_DELAY_MS
  • TIMEOUT_MS
  • MAX_POLL_TIME_MINUTES
  • POLL_INTERVAL_SECONDS
  • POLL_TIMEOUT_SECONDS
  • PINME_TRACKER_GATEWAY
  • PINME_TRACKING_DISABLED
  • DO_NOT_TRACK

Command Parity

pinme login [--env test|prod]
pinme set-appkey [AppKey]
pinme show-appkey
pinme appkey
pinme logout

pinme upload [path] [--domain name] [--dns]
pinme bind [path] --domain name [--dns]
pinme import [path] [--domain name]
pinme export <cid> [--output dir]
pinme rm [value]

pinme create [name] [--force]
pinme save [--domain name]
pinme update-worker
pinme update-db
pinme update-web
pinme delete [name] [--force]

pinme my-domains
pinme domain
pinme wallet
pinme wallet-balance
pinme balance
pinme list [-l limit]
pinme ls [-l limit]
pinme list --clear

Notes

  • Uploads use the same chunk endpoints: /chunk/init, /chunk/upload, /chunk/complete, and /up_status.
  • Project commands still expect the official PinMe Worker template shape: pinme.toml, backend/metadata.json, dist-worker/worker.js, db/*.sql, and frontend/dist.
  • create downloads glitternetwork/pinme-worker-template as a zip archive, then runs the same npm run build:* commands used by the Node CLI.
  • Tracking is best-effort and never blocks CLI flows. Disable it with PINME_TRACKING_DISABLED=1 or DO_NOT_TRACK=1.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pinme_python-1.0.1.tar.gz (26.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pinme_python-1.0.1-py3-none-any.whl (33.1 kB view details)

Uploaded Python 3

File details

Details for the file pinme_python-1.0.1.tar.gz.

File metadata

  • Download URL: pinme_python-1.0.1.tar.gz
  • Upload date:
  • Size: 26.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for pinme_python-1.0.1.tar.gz
Algorithm Hash digest
SHA256 b618f77b564313d77beb0d5efd745789f3d01b286bea960dd048d2fe96e021e3
MD5 a3e9e2399a9c515f480a87783aa35777
BLAKE2b-256 b8b63460b8878a16e2e2bc7498a2199056cf5ccf7dc681043df9fa6c25d515e1

See more details on using hashes here.

File details

Details for the file pinme_python-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: pinme_python-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 33.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for pinme_python-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1cb6e0a8a9ebb5af57bdbffbb52bb5baa188fcdfdc7603f23bea3ba6e22b51be
MD5 55acd5f3aa01f0b05d539b2914665f11
BLAKE2b-256 8fe0f228f7f1b22be0dd5120f3c97c5c351a56440af7fc8af8d6577f5c9c29f1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page