|
3 | 3 | "projectTitle": "Xquik Python SDK", |
4 | 4 | "description": "Official Python SDK for Xquik's X/Twitter API: typed sync and async clients for tweet search, user lookup, webhooks, MCP, monitors, and extractions.", |
5 | 5 | "branch": "main", |
| 6 | + "excludeFolders": [ |
| 7 | + ".devcontainer", |
| 8 | + ".github", |
| 9 | + ".vscode", |
| 10 | + "bin", |
| 11 | + "scripts", |
| 12 | + "tests" |
| 13 | + ], |
| 14 | + "excludeFiles": [ |
| 15 | + ".python-version", |
| 16 | + ".release-please-manifest.json", |
| 17 | + ".stats.yml", |
| 18 | + "Brewfile", |
| 19 | + "CHANGELOG.md", |
| 20 | + "CITATION.cff", |
| 21 | + "CODE_OF_CONDUCT.md", |
| 22 | + "CONTRIBUTING.md", |
| 23 | + "LICENSE", |
| 24 | + "SECURITY.md", |
| 25 | + "release-please-config.json", |
| 26 | + "requirements-dev.lock", |
| 27 | + "uv.lock" |
| 28 | + ], |
6 | 29 | "rules": [ |
7 | | - "Use README.md first for install, API key setup, sync and async client examples, webhooks, MCP, and common workflows.", |
| 30 | + "Install from PyPI package x_twitter_scraper, then import x_twitter_scraper.", |
| 31 | + "Authenticate with XTwitterScraper api_key or the X_TWITTER_SCRAPER_API_KEY environment variable.", |
| 32 | + "Use README.md first for install, authentication, first request, retries, raw responses, uploads, pagination, webhooks, MCP, and common workflows.", |
8 | 33 | "Use api.md for the generated resource map, method names, request parameters, response types, and endpoint coverage.", |
9 | | - "Use pyproject.toml and the PyPI package x_twitter_scraper for package metadata and supported Python versions.", |
10 | | - "Prefer X_TWITTER_SCRAPER_API_KEY environment configuration; never put API keys in source files or examples.", |
| 34 | + "Use pyproject.toml for package name, license, project URLs, Python version, dependency metadata, and package file includes.", |
| 35 | + "Use src/x_twitter_scraper/resources and src/x_twitter_scraper/types for generated Python method names and typed request parameters.", |
| 36 | + "Use src/x_twitter_scraper/resources/x/tweets/tweets.py for tweet search, posting, replies, retweets, likes, and tweet retrieval workflows.", |
| 37 | + "Use src/x_twitter_scraper/resources/x/media.py, src/x_twitter_scraper/resources/monitors.py, src/x_twitter_scraper/resources/webhooks.py, and src/x_twitter_scraper/resources/extractions.py for media, monitoring, webhook, and bulk extraction workflows.", |
11 | 38 | "For Python code, show XTwitterScraper for sync usage and AsyncXTwitterScraper for async usage.", |
12 | | - "Keep generated Stainless conventions intact and align feature claims with the Xquik OpenAPI/docs surface." |
| 39 | + "Never expose API keys, bearer tokens, webhook signing values, user credentials, or local runtime secrets in examples, logs, or commits." |
13 | 40 | ], |
14 | 41 | "url": "https://context7.com/xquik-dev/x-twitter-scraper-python", |
15 | 42 | "public_key": "pk_oCPeRRqZFJsY4cCUSotDD" |
|
0 commit comments