Skip to content

Commit f8b4733

Browse files
Merge branch 'main' into feature/oauth-google-cloud-storage
2 parents 63fb656 + 27ced77 commit f8b4733

File tree

18 files changed

+1342
-668
lines changed

18 files changed

+1342
-668
lines changed

.github/dependabot.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,7 @@ updates:
2020
docusaurus:
2121
patterns:
2222
- "@docusaurus/*"
23+
react:
24+
patterns:
25+
- "react"
26+
- "react-dom"

.github/maintainers_guide.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,9 @@ our continuous integration](https://github.com/slackapi/python-slack-sdk/blob/v3
6565

6666
## Tasks
6767

68-
### Testing (Unit Tests)
68+
### Testing
69+
70+
#### Unit Tests
6971

7072
When you make changes to this SDK, please write unit tests verifying if the changes work as you expected. You can easily run all the tests and formatting/linter with the below scripts.
7173

@@ -89,7 +91,7 @@ $ ./scripts/run_unit_tests.sh tests/web/test_web_client.py
8991

9092
You can rely on GitHub Actions builds for running the tests on a variety of Python runtimes.
9193

92-
### Testing (Integration Tests with Real Slack APIs)
94+
#### Integration Tests with Real Slack APIs
9395

9496
This project also has integration tests that verify the SDK works with the Slack API platform. As a preparation, you need to set [the required env variables](https://github.com/slackapi/python-slack-sdk/blob/main/integration_tests/env_variable_names.py) properly. You don't need to setup all of them if you just want to run some of the tests. Commonly, `SLACK_SDK_TEST_BOT_TOKEN` and `SLACK_SDK_TEST_USER_TOKEN` are used for running `WebClient` tests.
9597

@@ -105,6 +107,24 @@ Run a specific integration test:
105107
$ ./scripts/run_integration_tests.sh integration_tests/web/test_async_web_client.py
106108
```
107109

110+
#### Develop Locally
111+
112+
If you want to test the package locally you can.
113+
114+
1. Build the package locally
115+
- Run
116+
```bash
117+
scripts/build_pypi_package.sh
118+
```
119+
- This will create a `.whl` file in the `./dist` folder
120+
2. Use the built package
121+
- Example `/dist/slack_sdk-1.2.3-py2.py3-none-any.whl` was created
122+
- From anywhere on your machine you can install this package to a project with
123+
```bash
124+
pip install <project path>/dist/slack_sdk-1.2.3-py2.py3-none-any.whl
125+
```
126+
- It is also possible to include `slack_sdk @ file:///<project path>/dist/slack_sdk-1.2.3-py2.py3-none-any.whl` in a [requirements.txt](https://pip.pypa.io/en/stable/user_guide/#requirements-files) file
127+
108128
### Generating Documentation
109129

110130
See [`/docs/README`](https://github.com/slackapi/python-slack-sdk/blob/main/docs/README.md) for information on editing documentation pages.

docs/content/tutorial/uploading-files.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -182,11 +182,11 @@ By doing this, you'll be able to see the file within Slack.
182182

183183
### Specifying a channel when uploading a file {#specifying-channel}
184184

185-
While this exercise was very informative, having to do these two steps every time we upload a file is a bit cumbersome. Instead, we can specify the `channel_id` parameter to the function. This is the more common way of uploading a file from an app.
185+
While this exercise was very informative, having to do these two steps every time we upload a file is a bit cumbersome. Instead, we can specify the `channel` parameter to the function. This is the more common way of uploading a file from an app.
186186

187187
```python
188188
upload_and_then_share_file = client.files_upload_v2(
189-
channel_id="C123456789",
189+
channel="C123456789",
190190
title="Test text data",
191191
filename="test.txt",
192192
content="Hi there! This is a text file!",
@@ -210,7 +210,7 @@ Next, within the same directory, execute the following code. We'll specify the f
210210

211211
```python
212212
upload_text_file = client.files_upload_v2(
213-
channel_id="C123456789",
213+
channel="C123456789",
214214
title="Test text data",
215215
file="./test.txt",
216216
initial_comment="Here is the file:",

docs/navbarConfig.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ const navbar = {
7575
},
7676
{
7777
label: 'Your apps',
78-
to: 'https:api.slack.com/apps',
78+
to: 'https://api.slack.com/apps',
7979
position: 'right',
8080
target: '_blank',
8181
rel: "noopener noreferrer"

0 commit comments

Comments
 (0)