Skip to content

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

@binarycat0

Description

@binarycat0

Is your feature request related to a problem? Please describe.

Change the name property in the client/python/pyproject.toml file for the more proper one.

As a part of the initiative #2419 we have to keep in mind about the package name which will be published in PYPI packages repo. The current name in pyproject.toml file is already taken by other project which is not related to Apache Polaris Catalog project.

Current state:

name = "polaris"
description = "Apache Polaris"

...

[project.scripts]
polaris = "cli.polaris_cli:main"

Describe the solution you'd like

My proposal is to use apache-polaris-sdk as a python package name which will reflect not only one functionally, which is just ./polaris CLI tool, but also as the Apache Polaris Python SDK that can be used in any Python project by any Python Developer.

name = "apache-polaris-sdk"
description = "Apache Polaris Catalog API Python SDK"

...

[project.scripts]
polaris_py_cli = "cli.polaris_cli:main"

In the ./polaris executable file, replace ./polaris-venv/bin/polaris reference to ./polaris-venv/bin/polaris_py_cli for backward capability.

Describe alternatives you've considered

[PROPOSAL] Also, it could be better to reorganize catalogs structure in ./client/python, at least add one more level, for providing more clear idea of using future apache-polaris-sdk module as SDK.

# current state
from polaris import catalog
from polaris import management

# proposed version
# from apache_polaris.sdk import management
# from apache_polaris.sdk import catalog

Additional context

Currently, in the pypi packages repo the names started with polaris.* are taken by other projects not related to Apache Polaris Catalog - https://pypi.org/search/?q=polaris&o=

polaris
polaris-cli
polaris-sdk
polaris-py

etc.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    Status

    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions