python-style

作者: contentstack

用于contentstack-python中的Python包布局、setup.py约定及样式。

npx skills add https://github.com/contentstack/contentstack-python --skill python-style

Python style – Contentstack CDA SDK

When to use

  • Editing any Python under contentstack/, setup.py, or requirements.txt.
  • Adding modules or changing how the public package surface is exported.

Instructions

Layout

PathRole
contentstack/stack.pyStack, ContentstackRegion
contentstack/query.py, basequery.pyQuery building
contentstack/entry.py, asset.py, contenttype.pyDomain objects
contentstack/taxonomy.py, globalfields.py, variants.pyAdvanced features
contentstack/https_connection.py, controller.pyHTTP session + request dispatch
contentstack/error_messages.py, utility.pyShared helpers
contentstack/__init__.pyPublic exports (Stack, Entry, Asset, …), __version__

Style

  • Match existing patterns (typing on Stack, unittest-style tests in tests/).
  • Prefer clear public APIs over internal churn; keep module boundaries similar to neighboring files.

Dependencies

  • requests, python-dateutil, urllib3 (Retry) — see setup.py install_requires.
  • Do not add new runtime dependencies without updating setup.py and requirements.txt.

Security

  • Do not log delivery_token, preview_token, api_key, or management_token; follow existing logging in Stack.