Skip to content

Fix: replace pylint with ruff in dev requirements (Snyk GPL/LGPL) #193

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
reeshika-h wants to merge 1 commit into
base: development
Choose a base branch
from
Open

Fix: replace pylint with ruff in dev requirements (Snyk GPL/LGPL) #193

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
| Build | `setuptools` / `setup.py`; package `contentstack_management` |
| HTTP | `requests`, `requests-toolbelt`, `urllib3` |
| Tests | `pytest` — `tests/integration` (live e2e / sanity, dynamic stack), `tests/unit`, `tests/mock`, `tests/api` (legacy, superseded by `tests/integration`) |
| Lint / coverage | `pylint`, `coverage` (see `requirements-dev.txt`) |
| Lint / coverage | `ruff`, `coverage` (see `requirements-dev.txt`) |
| Secrets / hooks | Talisman, Snyk (see `README.md` development setup) |

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

> **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.

Expand All @@ -70,7 +70,7 @@ Do not commit secrets. `tests/integration/.env`, `docs/`, and the repo-root `cma

| Skill | Path | What it covers |
|-------|------|----------------|
| **Development workflow** | [`skills/dev-workflow/SKILL.md`](skills/dev-workflow/SKILL.md) | Install, pytest suites, packaging version, pylint, hooks, PR baseline |
| **Development workflow** | [`skills/dev-workflow/SKILL.md`](skills/dev-workflow/SKILL.md) | Install, pytest suites, packaging version, ruff, hooks, PR baseline |
| **Contentstack Management (SDK)** | [`skills/contentstack-management/SKILL.md`](skills/contentstack-management/SKILL.md) | **`Client`**, **`Stack`**, **`_APIClient`**, CMA resources, OAuth, CMA docs |
| **Python style & repo layout** | [`skills/python-style/SKILL.md`](skills/python-style/SKILL.md) | Package layout, naming, imports via **`_APIClient`**, secrets in logs |
| **Testing** | [`skills/testing/SKILL.md`](skills/testing/SKILL.md) | pytest unit / API / mock, **`tests/cred.py`**, env hygiene |
Expand Down
4 changes: 2 additions & 2 deletions requirements-dev.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Development-only dependencies — not shipped in the production package.
# Keep linting/tools (e.g. pylint) here so production scans can exclude them.
# Keep linting/tools (e.g. ruff) here so production scans can exclude them.
-r requirements.txt
pylint>=2.0.0
ruff>=0.11.5
2 changes: 1 addition & 1 deletion skills/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Source of truth for detailed guidance. Read **[`AGENTS.md`](../AGENTS.md)** firs

| Skill folder | Use when |
|--------------|----------|
| **dev-workflow** | Install, **`pytest`** (unit / API / mock), **`__version__`**, pylint, Talisman/Snyk, before PR |
| **dev-workflow** | Install, **`pytest`** (unit / API / mock), **`__version__`**, ruff, Talisman/Snyk, before PR |
| **contentstack-management** | **`Client`**, **`Stack`**, **`_APIClient`**, domain modules, OAuth, CMA paths and payloads |
| **python-style** | Editing **`contentstack_management/`** or **`setup.py`** / **`requirements.txt`**—layout, style, imports |
| **testing** | Adding or changing tests under **`tests/`**, **`tests/cred.py`**, env for API runs |
Expand Down
4 changes: 2 additions & 2 deletions skills/dev-workflow/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: dev-workflow
description: Use for install, pytest suites, versioning, pylint, hooks, and PR baseline in contentstack-management-python.
description: Use for install, pytest suites, versioning, ruff, hooks, and PR baseline in contentstack-management-python.
---

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

### Tooling

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

### Pull requests
Expand Down
2 changes: 1 addition & 1 deletion skills/python-style/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: python-style
description: Use for package layout under contentstack_management/, setup.py, pylint-friendly style, and imports.
description: Use for package layout under contentstack_management/, setup.py, lint-friendly style, and imports.
---

# Python style and repo layout – Contentstack Management Python
Expand Down
Loading