Skip to content

Comments

Configuring with pyproject.toml#1436

Merged
WilliamBergamin merged 8 commits intoslackapi:mainfrom
WilliamBergamin:pyproject-toml-configuration
Dec 6, 2023
Merged

Configuring with pyproject.toml#1436
WilliamBergamin merged 8 commits intoslackapi:mainfrom
WilliamBergamin:pyproject-toml-configuration

Conversation

@WilliamBergamin
Copy link
Contributor

@WilliamBergamin WilliamBergamin commented Nov 29, 2023

Summary

This PR is an extension of #bolt-996 and aims to follow its spirit. It introduces changes that make the pyproject.toml file the default configuration file for python-slack-sdk

The setup.py file is now used as support for "legacy" commands in this project

Requirements File Format pattern is used to import test dependencies. This creates a clear distinction between the project dependencies and the development dependencies.

Category

  • slack_sdk.web.WebClient (sync/async) (Web API client)
  • slack_sdk.webhook.WebhookClient (sync/async) (Incoming Webhook, response_url sender)
  • slack_sdk.socket_mode (Socket Mode client)
  • slack_sdk.signature (Request Signature Verifier)
  • slack_sdk.oauth (OAuth Flow Utilities)
  • slack_sdk.models (UI component builders)
  • slack_sdk.scim (SCIM API client)
  • slack_sdk.audit_logs (Audit Logs API client)
  • slack_sdk.rtm_v2 (RTM client)
  • /docs-src (Documents, have you run ./scripts/docs.sh?)
  • /docs-src-v2 (Documents, have you run ./scripts/docs-v2.sh?)
  • /tutorial (PythOnBoardingBot tutorial)
  • tests/integration_tests (Automated tests for this library)

Requirements

  • I've read and understood the Contributing Guidelines and have done my best effort to follow them.
  • I've read and agree to the Code of Conduct.
  • I've run python3 -m venv .venv && source .venv/bin/activate && ./scripts/run_validation.sh after making the changes.

@WilliamBergamin WilliamBergamin added the enhancement M-T: A feature request for new functionality label Nov 29, 2023
@WilliamBergamin WilliamBergamin self-assigned this Nov 29, 2023
@codecov
Copy link

codecov bot commented Nov 29, 2023 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (ef883ad) 85.59% compared to head (69b73eb) 85.44%.

❗ Current head 69b73eb differs from pull request most recent head dc6c2e6. Consider uploading reports for the commit dc6c2e6 to get more accurate results

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #1436      +/-   ##
==========================================
- Coverage   85.59%   85.44%   -0.15%     
==========================================
  Files         111      111              
  Lines       12128    12113      -15     
==========================================
- Hits        10381    10350      -31     
- Misses       1747     1763      +16

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

seratch
seratch approved these changes Nov 30, 2023
View reviewed changes
Copy link
Contributor

@seratch seratch left a comment

Choose a reason for hiding this comment

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

Nice! You can merge this after verifying the test.pypi.org works with it

@seratch seratch added this to the 3.26.1 milestone Nov 30, 2023
@seratch
Copy link
Contributor

seratch commented Nov 30, 2023

@WilliamBergamin An external contribution #1435 to add PyPy support etc. was merged. Can you update this PR accordingly?

Jamim
Jamim suggested changes Nov 30, 2023
View reviewed changes
Copy link
Contributor

@Jamim Jamim left a comment

Choose a reason for hiding this comment

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

Hello @WilliamBergamin,
I've found a few inclusions of slack_bolt to this PR which, I suppose, are not intentional.

WilliamBergamin and others added 2 commits November 30, 2023 10:23
@WilliamBergamin @Jamim
Update pyproject.toml
1f8ae55 
Co-authored-by: Aliaksei Urbanski <[email protected]>
@WilliamBergamin @Jamim
Update scripts/build_pypi_package.sh
8e9fb8a 
Co-authored-by: Aliaksei Urbanski <[email protected]>
@WilliamBergamin
Copy link
Contributor Author

WilliamBergamin commented Nov 30, 2023

@Jamim thanks a lot for the review, got some good catches 💯

@WilliamBergamin
Copy link
Contributor Author

WilliamBergamin commented Nov 30, 2023 •
edited
Loading

I realized this morning that this PR may change the behavior of of the pip show slack-sdk command

previously

Name: slack-sdk
Version: 3.26.0
Summary: The Slack API Platform SDK for Python
Home-page: https://github.com/slackapi/python-slack-sdk
Author: Slack Technologies, LLC
Author-email: [email protected]
License: MIT
Location: /experiments/python_func_handler_mvp/env_3_11_2/lib/python3.11/site-packages
Requires: 
Required-by: slack-bolt

New

Name: slack-sdk
Version: 3.26.0
Summary: The Slack API Platform SDK for Python
Home-page: 
Author: 
Author-email: "Slack Technologies, LLC" <[email protected]>
License: MIT
Location: experiments/python_func_handler_mvp/env_3_11_2/lib/python3.11/site-packages
Requires: 
Required-by: slack-bolt

I'm not sure how developers may use this command but these changes could change their flow
@seratch let me know if the output of this command needs to be maintained, I believe it can be done by adding some fields in a setup.cfg file (this can also be added in a follow up PR)

@seratch
Copy link
Contributor

seratch commented Dec 1, 2023

@seratch let me know if the output of this command needs to be maintained, I believe it can be done by adding some fields in a setup.cfg file (this can also be added in a follow up PR)

@WilliamBergamin Yeah, we should keep those metadata too. Can you make the changes for the compatibility?

@WilliamBergamin
Copy link
Contributor Author

WilliamBergamin commented Dec 1, 2023 •
edited
Loading

@seratch I've added the necessary changes to maintain the behavior of the pip show slack-sdk command

here is the output

Name: slack-sdk
Version: 3.26.0b1
Summary: The Slack API Platform SDK for Python
Home-page: https://github.com/slackapi/python-slack-sdk
Author: Slack Technologies, LLC
Author-email: [email protected]
License: MIT
Location: /Users/env_3.11.2/lib/python3.11/site-packages
Requires: 
Required-by:

I've also deployed to https://test.pypi.org/project/slack-sdk I believe the deploy behavior is maintained

@WilliamBergamin WilliamBergamin mentioned this pull request Dec 1, 2023
Merged
8 tasks
@seratch seratch modified the milestones: 3.26.1, 3.26.2 Dec 4, 2023
@WilliamBergamin WilliamBergamin merged commit 69638bf into slackapi:main Dec 6, 2023
@WilliamBergamin WilliamBergamin deleted the pyproject-toml-configuration branch December 6, 2023 18:41
@WilliamBergamin WilliamBergamin mentioned this pull request Mar 4, 2024
Merged
16 tasks
@WilliamBergamin WilliamBergamin mentioned this pull request Dec 16, 2024
Merged
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers

@seratch seratch seratch approved these changes

@Jamim Jamim Jamim approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@WilliamBergamin WilliamBergamin

Labels

enhancement M-T: A feature request for new functionality

Projects

None yet

Milestone

3.26.2

Development

Successfully merging this pull request may close these issues.

3 participants

@WilliamBergamin @seratch @Jamim