Skip to content

Conversation

@binarycat0
Copy link
Contributor

@binarycat0 binarycat0 commented Oct 14, 2025

  • change package name from polaris to apache-polaris
  • reorganize python package catalogs
  • union all submodules (cli, polaris) under apache_polaris module
  • put polaris generated context into apache_polaris/sdk
  • make apache_polaris as a main module

Fixes: #2699

What changes were proposed in this pull request?

Package name

As discussed in the mailing list thread, the majority agreed that a more suitable and compliant name would be apache-polaris according to the Apache Distribution guide

pip install apache-polaris
polaris --help

Catalogs structure

It would be beneficial to modify the directory structure. The current setup can lead to conflicts after package installation because it doesn't create a parent directory to group all apache-polaris related modules together. Instead, it directly places the cli and polaris directories into the root .../site-packages of the active environment.

/site_packages/
├── cli
├── polaris
│   ├── catalog
└── └── management

In the structure I am proposing, all modules related to the project will be placed in the apache_polaris module and will be available for use in code through import apache_polaris.sdk.catalog, apache_polaris.sdk.management and import apache_polaris.cli respectively.

/site-packages/
├── apache_polaris
│   ├── cli
│   └── sdk
│       ├── catalog
│       └── management
>>> from apache_polaris.sdk import catalog
>>> from apache_polaris.sdk import management

Why are the changes needed?

Initial Issue: #2419
Follow up Issue: #2699

Does this PR introduce any user-facing change?

How was this patch tested?

make client-cleanup
make client-regenerate
make client-lint
make client-integration-test
make client-unit-test

CHANGELOG.md

@github-project-automation github-project-automation bot moved this to PRs In Progress in Basic Kanban Board Oct 14, 2025
@binarycat0 binarycat0 force-pushed the chore/enhancement/2699-change-python-package-name branch 2 times, most recently from 0d34b23 to 395cb27 Compare October 16, 2025 09:23
@binarycat0 binarycat0 force-pushed the chore/enhancement/2699-change-python-package-name branch from 4e6bbc6 to e797543 Compare October 23, 2025 21:41
@binarycat0 binarycat0 marked this pull request as ready for review October 26, 2025 10:08
@adutra adutra requested a review from MonkeyCanCode October 26, 2025 11:25
@binarycat0
Copy link
Contributor Author

@MonkeyCanCode @HonahX Hello colleagues. Please review. Thx 🙏

@MonkeyCanCode
Copy link
Contributor

Hello, sorry for the delay. I will check this weekend.

@MonkeyCanCode @HonahX Hello colleagues. Please review. Thx 🙏

`apache_polaris.sdk.catalog.models.LoadPolicyResponse`.
However, the generator fails to add the necessary `import` statements
to the `polaris/catalog/models/__init__.py` file. This means that even
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

polaris/catalog/models/__init__.py is now outdated with this PR. Change to apache_polaris/sdk/catalog/models/__init__.py

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@binarycat0 mind update here as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, good catch! I need to double-check all places properly 👍

`apache_polaris.sdk.catalog.models.LoadPolicyResponse`.
However, the generator fails to add the necessary `import` statements
to the `polaris/catalog/models/__init__.py` file. This means that even
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Path polaris/catalog/models/__init__.py is outdated. Change to apache_polaris/sdk/catalog/models/__init__.py

@MonkeyCanCode
Copy link
Contributor

Hello, sorry for the delay. I will check this weekend.

@MonkeyCanCode @HonahX Hello colleagues. Please review. Thx 🙏

@binarycat0 nice work and thanks for the coordination on the dev ML.

@binarycat0 binarycat0 force-pushed the chore/enhancement/2699-change-python-package-name branch from 15c0342 to d97136e Compare November 3, 2025 13:45
@binarycat0
Copy link
Contributor Author

binarycat0 commented Nov 3, 2025

Hello @MonkeyCanCode 👋, thank you for the review. I fixed the mentioned NIT comments, thanks.

Also, the mentioned string splitters by () is caused by automatically formatting or by make client-lint command. If the make client-lint command does not contain the black formatting, I would propose implement it there.

In my experience an applying "isort + mypy + black" linting was by default, I would like suggest following the same standard as many python projects.

Hello, sorry for the delay. I will check this weekend.

@MonkeyCanCode @HonahX Hello colleagues. Please review. Thx 🙏

@binarycat0 nice work and thanks for the coordination on the dev ML.

@MonkeyCanCode
Copy link
Contributor

Hello @MonkeyCanCode 👋, thank you for the review. I fixed the mentioned NIT comments, thanks.

Also, the mentioned string splitters by () is caused by automatically formatting or by make client-lint command. If the make client-lint command does not contain the black formatting, I would propose implement it there.

In my experience an applying "isort + mypy + black" linting was by default, I would like suggest following the same standard as many python projects.

Hello, sorry for the delay. I will check this weekend.

@MonkeyCanCode @HonahX Hello colleagues. Please review. Thx 🙏

@binarycat0 nice work and thanks for the coordination on the dev ML.

Thanks for the quick fix. One of the minor comment was not fixed. Other than that, this looks good to me. @eric-maynard @HonahX , do u mind also take a look when u have a chance?

@binarycat0
Copy link
Contributor Author

@MonkeyCanCode Thank you again. I double-checked all places, now it should be good.

@github-project-automation github-project-automation bot moved this from PRs In Progress to Ready to merge in Basic Kanban Board Nov 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Change the name property in the client/python/pyproject.toml file

3 participants