fix: version and package name in sdk#8

Prashant-Surya

Description

Use package name as plane-sdk
Use version from pyproject.toml instead of setup.py for releases

Type of Change

Bug fix (non-breaking change which fixes an issue)

Summary by CodeRabbit

Chores
- Project package name and metadata updated for clarity and consistency.
- Contact/author metadata updated.
- Version extraction updated to use the project's primary packaging metadata.
- Removed generated API client, related docs, and scaffolding to simplify the repository.
- CI and CI-related configuration files removed as part of cleanup.

coderabbitai

Walkthrough

Version extraction in the publish workflow is moved from setup.py to pyproject.toml. The repository removes multiple generated/OpenAPI artifacts and CI configuration files, and pyproject.toml metadata (project name and author email) is updated.

Changes

Cohort / File(s) Summary

Publish workflow version extraction \.github/workflows/publish.yml	Changed version extraction to grep pyproject.toml for version = instead of reading setup.py. Control flow and error handling preserved.
Project metadata pyproject.toml	Updated project.name from plane-python-sdk to plane-sdk, changed author email to engineering@plane.so, added setuptools find config and multiple tooling config blocks, and removed trailing blank lines.
Removed GitLab CI .gitlab-ci.yml	Deleted file that defined a multi-version Python test matrix and related jobs.
Removed Travis CI .travis.yml	Deleted Travis CI configuration that ran pytest across Python versions.
Removed OpenAPI generator ignore .openapi-generator-ignore	Deleted documentation/example ignore rules for OpenAPI Generator.
Removed OpenAPI generated artifacts .openapi-generator/FILES, .openapi-generator/VERSION, and many generated files under -plane/, docs/, top-level packaging and CI files (e.g., setup.py, setup.cfg, requirements.txt, test-requirements.txt, tox.ini, etc.)*	Massive removal of generated API client, documentation, CI/configuration, and packaging artifacts; .openapi-generator/VERSION content removed. (Many files and directories deleted; see diff for full list.)

Sequence Diagram(s)

sequenceDiagram autonumber actor GitHubActions as "Publish Workflow" participant Repo as "Repository" Note over GitHubActions,Repo: Old flow (before change) GitHubActions->>Repo: read `setup.py` Repo-->>GitHubActions: content with version string Note over GitHubActions,Repo: New flow (after change) GitHubActions->>Repo: grep `pyproject.toml` for "version = " Repo-->>GitHubActions: matched version line(s) GitHubActions->>GitHubActions: extract first match and proceed alt no match GitHubActions->>GitHubActions: print error & exit end

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~45 minutes

Rationale: large, heterogeneous deletions of generated client, docs, CI and packaging files plus metadata edits require careful review to ensure no needed artifacts were removed and workflows still function.
Areas needing extra attention:
- Confirm intentional removal of the entire generated client and documentation under -plane/ and docs/.
- Validate CI coverage removal (GitLab, Travis) and update any remaining CI/workflow references.
- Verify pyproject.toml metadata and tooling blocks are correct and complete.
- Ensure .github/workflows/publish.yml change matches other release automation expectations.

Poem

🐰
I hopped through files with nimble paw,
Changed where the version comes from (oh my jaw!),
Name trimmed and tool-maps set just so,
Cleared the generated footprints from the snow,
Ready to leap—onward we go! 🥕

Pre-merge checks and finishing touches

❌ Failed checks (1 warning) Check name Status Explanation Resolution

Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (2 passed) Check name Status Explanation

Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title "fix: version and package name in sdk" is directly related to the main changes in the pull request. According to the PR objectives, the primary changes are updating the package name to "plane-sdk" and changing the version extraction from setup.py to pyproject.toml in the publish workflow. The title concisely captures both of these core objectives without being vague or overly broad. While the changeset includes some cleanup of CI/CD and generated artifact files, these are secondary to the main purpose stated in the PR description, making this title sufficiently specific and aligned with the primary intent.

✨ Finishing touches 🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch fix/publish-action

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d77c4e7 and e877f45.

📒 Files selected for processing (7)

.github/workflows/publish.yml (1 hunks)
.gitlab-ci.yml (0 hunks)
.openapi-generator-ignore (0 hunks)
.openapi-generator/FILES (0 hunks)
.openapi-generator/VERSION (0 hunks)
.travis.yml (0 hunks)
pyproject.toml (1 hunks)

💤 Files with no reviewable changes (5)

.openapi-generator/VERSION
.travis.yml
.gitlab-ci.yml
.openapi-generator-ignore
.openapi-generator/FILES

🚧 Files skipped from review as they are similar to previous changes (1)

.github/workflows/publish.yml

🔇 Additional comments (5) pyproject.toml (5)

6-6: Verify impact of package name change from "plane-python-sdk" to "plane-sdk".

This is a breaking change for existing pip installations. Users with "plane-python-sdk" will need to reinstall "plane-sdk" explicitly. The PR summary indicates this is a "non-breaking change," but renaming the published package name is semantically a breaking change from a distribution/installation perspective.

Ensure that:

Downstream projects using this package are aware of and prepared for the name change.
A migration guide or deprecation notice is provided if needed.
The old package name ("plane-python-sdk") is either deprecated or yanked from PyPI to avoid confusion.

7-7: Version extraction source updated correctly.

The version is now defined in pyproject.toml and will be the single source of truth for the publish workflow. Ensure the publish workflow correctly extracts the version using the expected pattern (e.g., grep "version = ").

12-12: Author email updated to organizational account.

The email change from "dev@plane.so" to "engineering@plane.so" is a reasonable organizational update.

15-17: Setuptools discovery configuration added.

The package discovery configuration with include = ["plane*"] will locate all packages matching the "plane*" pattern in the repository root. Verify that all intended packages are discovered with this pattern.

19-43: Tool configurations added for code quality and testing.

Added configurations for black, ruff, pytest, and mypy enable standardized tooling across the project. These are reasonable development tool configurations:

Black and ruff for code formatting and linting
Pytest for testing with test path constraints
Mypy for strict type checking on Python 3.10+

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Prashant-Surya requested a review from dheeru0198 October 31, 2025 14:14

Prashant-Surya added 2 commits October 31, 2025 19:52

fix: version and package name in sdk

293ca78

delete un-used files

e877f45

Prashant-Surya force-pushed the fix/publish-action branch from d77c4e7 to e877f45 Compare October 31, 2025 14:25

sriramveeraghanta approved these changes Oct 31, 2025

View reviewed changes

sriramveeraghanta deleted the fix/publish-action branch October 31, 2025 14:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix: version and package name in sdk#8