Skip to content

install: Migrate from setup.py to pyproject.toml. #875

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.

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
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

rht
Copy link
Contributor

@rht rht commented Jul 26, 2025

  • I use Hatch instead of Setuptools because Setuptools data-files doesn't
    support recursive file includes.

Fixes: N/A

How did you test this PR?

  • Running pytest tests
  • Running my own script to automate uploading a file to a given topic in a channel
  • Ensured that the target data files, share/zulip has the same content as when installed in current main
  • Self-reviewed the changes for clarity and maintainability
    (variable names, code reuse, readability, etc.).

Communicate decisions, questions, and potential concerns.

  • Explains differences from previous plans (e.g., issue description).
  • Highlights technical choices and bugs encountered.
  • Calls out remaining decisions and concerns.
  • Automated tests verify logic where appropriate.

Individual commits are ready for review (see commit discipline).

  • Each commit is a coherent idea.
  • Commit message(s) explain reasoning and motivation for changes.

Completed manual review and testing of the following:

  • Visual appearance of the changes.
  • Responsiveness and internationalization.
  • Strings and tooltips.
  • End-to-end functionality of buttons, interactions and flows.
  • Corner cases, error conditions, and easily imagined bugs.

name="zulip",
version=version(),
description="Bindings for the Zulip message API",
long_description=long_description,
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is superseded by readme = "README.md" in the pyproject.toml version. I checked the resulting METADATA file in the package info, and it showed the entire README.md in it.

Source = "https://github.com/zulip/python-zulip-api/"
Documentation = "https://zulip.com/api"

[project.scripts]
Copy link
Contributor Author

@rht rht Jul 26, 2025

Choose a reason for hiding this comment

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

I confirmed that the scripts all exist in the installed virtualenv bin directory.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants