Skip to content

Commit f1090b9

Browse files
docs: include packaging script steps in the maintainers guide (#1672)
Co-authored-by: William Bergamin <[email protected]>
1 parent 85f8f4b commit f1090b9

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

.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.

0 commit comments

Comments
 (0)