Skip to content

Commit 5b35a27

Browse files
reeshika-hclaude
andcommitted
Fix: replace pylint with ruff in dev requirements
Remove GPL/LGPL dev-only dependencies (pylint, astroid); update docs. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
1 parent 75d96ff commit 5b35a27

5 files changed

Lines changed: 9 additions & 9 deletions

File tree

‎AGENTS.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
| Build | `setuptools` / `setup.py`; package `contentstack_management` |
1818
| HTTP | `requests`, `requests-toolbelt`, `urllib3` |
1919
| Tests | `pytest` — `tests/integration` (live e2e / sanity, dynamic stack), `tests/unit`, `tests/mock`, `tests/api` (legacy, superseded by `tests/integration`) |
20-
| Lint / coverage | `pylint`, `coverage` (see `requirements-dev.txt`) |
20+
| Lint / coverage | `ruff`, `coverage` (see `requirements-dev.txt`) |
2121
| Secrets / hooks | Talisman, Snyk (see `README.md` development setup) |
2222

2323
## Source layout
@@ -44,7 +44,7 @@
4444
| Test (mock) | `pytest tests/mock/ -v` |
4545
| Test (legacy API, live) | `pytest tests/api/ -v` (needs `.env` — see `tests/cred.py`) |
4646
| Coverage (CI) | `coverage run -m pytest tests/unit/` |
47-
| Lint | `pylint contentstack_management/` |
47+
| Lint | `ruff check contentstack_management/` |
4848

4949
> **CI note:** `.github/workflows/unit-test.yml` runs **only `tests/unit/`** (no credentials). The `tests/integration` sanity suite is run manually (or via a credential-gated job) because it provisions real stacks.
5050
@@ -70,7 +70,7 @@ Do not commit secrets. `tests/integration/.env`, `docs/`, and the repo-root `cma
7070

7171
| Skill | Path | What it covers |
7272
|-------|------|----------------|
73-
| **Development workflow** | [`skills/dev-workflow/SKILL.md`](skills/dev-workflow/SKILL.md) | Install, pytest suites, packaging version, pylint, hooks, PR baseline |
73+
| **Development workflow** | [`skills/dev-workflow/SKILL.md`](skills/dev-workflow/SKILL.md) | Install, pytest suites, packaging version, ruff, hooks, PR baseline |
7474
| **Contentstack Management (SDK)** | [`skills/contentstack-management/SKILL.md`](skills/contentstack-management/SKILL.md) | **`Client`**, **`Stack`**, **`_APIClient`**, CMA resources, OAuth, CMA docs |
7575
| **Python style & repo layout** | [`skills/python-style/SKILL.md`](skills/python-style/SKILL.md) | Package layout, naming, imports via **`_APIClient`**, secrets in logs |
7676
| **Testing** | [`skills/testing/SKILL.md`](skills/testing/SKILL.md) | pytest unit / API / mock, **`tests/cred.py`**, env hygiene |

‎requirements-dev.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Development-only dependencies — not shipped in the production package.
2-
# Keep linting/tools (e.g. pylint) here so production scans can exclude them.
2+
# Keep linting/tools (e.g. ruff) here so production scans can exclude them.
33
-r requirements.txt
4-
pylint>=2.0.0
4+
ruff>=0.11.5

‎skills/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Source of truth for detailed guidance. Read **[`AGENTS.md`](../AGENTS.md)** firs
66

77
| Skill folder | Use when |
88
|--------------|----------|
9-
| **dev-workflow** | Install, **`pytest`** (unit / API / mock), **`__version__`**, pylint, Talisman/Snyk, before PR |
9+
| **dev-workflow** | Install, **`pytest`** (unit / API / mock), **`__version__`**, ruff, Talisman/Snyk, before PR |
1010
| **contentstack-management** | **`Client`**, **`Stack`**, **`_APIClient`**, domain modules, OAuth, CMA paths and payloads |
1111
| **python-style** | Editing **`contentstack_management/`** or **`setup.py`** / **`requirements.txt`**—layout, style, imports |
1212
| **testing** | Adding or changing tests under **`tests/`**, **`tests/cred.py`**, env for API runs |

‎skills/dev-workflow/SKILL.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: dev-workflow
3-
description: Use for install, pytest suites, versioning, pylint, hooks, and PR baseline in contentstack-management-python.
3+
description: Use for install, pytest suites, versioning, ruff, hooks, and PR baseline in contentstack-management-python.
44
---
55

66
# Development workflow – Contentstack Management Python
@@ -30,7 +30,7 @@ description: Use for install, pytest suites, versioning, pylint, hooks, and PR b
3030

3131
### Tooling
3232

33-
- **pylint** is listed in **`requirements-dev.txt`**; follow existing style in touched files.
33+
- **ruff** is listed in **`requirements-dev.txt`** (lint with `ruff check contentstack_management/`); follow existing style in touched files.
3434
- **Husky / Talisman / Snyk** — see **README.md** for local hook setup.
3535

3636
### Pull requests

‎skills/python-style/SKILL.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: python-style
3-
description: Use for package layout under contentstack_management/, setup.py, pylint-friendly style, and imports.
3+
description: Use for package layout under contentstack_management/, setup.py, lint-friendly style, and imports.
44
---
55

66
# Python style and repo layout – Contentstack Management Python

0 commit comments

Comments
 (0)