python-style

Use for Python package layout, setup.py conventions, and style in contentstack-python.

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.

More skills from contentstack

cms-assets
contentstack
Advise developers on organizing, delivering, and transforming assets in Contentstack. Cover folder structure, Image Delivery API transformations, publishing…
cms-branches-aliases
contentstack
Advise developers on using Contentstack branches for isolated content development and aliases for zero-downtime content deployments. Cover branch strategy,…
cms-data-modeling-best-practices
contentstack
Guide developers to model content in Contentstack using the simplest reusable structure. The skill explains when to use content types, references, global…
cms-live-preview-visual-builder-support-assistant
contentstack
Diagnose and guide Contentstack Live Preview and Visual Builder implementations. Trace preview context, identify the broken contract, and recommend the…
cms-releases
contentstack
Advise developers on using Contentstack Releases for coordinated, atomic content deployment. Cover release creation, item management, staged deployment,…
cms-roles-permissions
contentstack
Advise developers on designing roles, permissions, teams, and token access in Contentstack. Explain built-in roles, custom roles, permission merging,…
cms-taxonomy
contentstack
Advise developers on using Contentstack Taxonomy for structured, hierarchical content classification and delivery-side filtering. Covers taxonomy vs tags,…
cms-tokens-authentication
contentstack
Advise developers on choosing the right Contentstack authentication method and token type for frontend, backend, automation, and third-party app use cases.…