Skip to content

Commit 640c64a

Browse files
committed
Replace python-slackclient in docs and GH templates
1 parent 95e9e04 commit 640c64a

26 files changed

+81
-81
lines changed

.github/ISSUE_TEMPLATE/01_question.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,4 +48,4 @@ sw_vers && uname -v # or `ver`
4848

4949
For general questions/issues about Slack API platform or its server-side, could you submit questions at https://my.slack.com/help/requests/new instead. :bow:
5050

51-
Please read the [Contributing guidelines](https://github.com/slackapi/python-slackclient/blob/main/.github/contributing.md) and [Code of Conduct](https://slackhq.github.io/code-of-conduct) before creating this issue or pull request. By submitting, you are agreeing to those rules.
51+
Please read the [Contributing guidelines](https://github.com/slackapi/python-slack-sdk/blob/main/.github/contributing.md) and [Code of Conduct](https://slackhq.github.io/code-of-conduct) before creating this issue or pull request. By submitting, you are agreeing to those rules.

.github/ISSUE_TEMPLATE/02_enhancement.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ assignees: ""
1919

2020
### Requirements
2121

22-
Please read the [Contributing guidelines](https://github.com/slackapi/python-slackclient/blob/main/.github/contributing.md) and [Code of Conduct](https://slackhq.github.io/code-of-conduct) before creating this issue or pull request. By submitting, you are agreeing to those rules.
22+
Please read the [Contributing guidelines](https://github.com/slackapi/python-slack-sdk/blob/main/.github/contributing.md) and [Code of Conduct](https://slackhq.github.io/code-of-conduct) before creating this issue or pull request. By submitting, you are agreeing to those rules.

.github/ISSUE_TEMPLATE/03_document.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ assignees: ""
1414

1515
### Requirements
1616

17-
Please read the [Contributing guidelines](https://github.com/slackapi/python-slackclient/blob/main/.github/contributing.md) and [Code of Conduct](https://slackhq.github.io/code-of-conduct) before creating this issue or pull request. By submitting, you are agreeing to those rules.
17+
Please read the [Contributing guidelines](https://github.com/slackapi/python-slack-sdk/blob/main/.github/contributing.md) and [Code of Conduct](https://slackhq.github.io/code-of-conduct) before creating this issue or pull request. By submitting, you are agreeing to those rules.

.github/ISSUE_TEMPLATE/04_bug.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,4 +48,4 @@ sw_vers && uname -v # or `ver`
4848

4949
For general questions/issues about Slack API platform or its server-side, could you submit questions at https://my.slack.com/help/requests/new instead. :bow:
5050

51-
Please read the [Contributing guidelines](https://github.com/slackapi/python-slackclient/blob/main/.github/contributing.md) and [Code of Conduct](https://slackhq.github.io/code-of-conduct) before creating this issue or pull request. By submitting, you are agreeing to those rules.
51+
Please read the [Contributing guidelines](https://github.com/slackapi/python-slack-sdk/blob/main/.github/contributing.md) and [Code of Conduct](https://slackhq.github.io/code-of-conduct) before creating this issue or pull request. By submitting, you are agreeing to those rules.

.github/contributing.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,16 @@ There are many ways you can contribute! :heart:
88

99
### Bug Reports and Fixes :bug:
1010

11-
- If you find a bug, please search for it in the [Issues](https://github.com/slackapi/python-slackclient/issues), and if it isn't already tracked,
12-
[create a new issue](https://github.com/slackapi/python-slackclient/issues/new). Fill out the "Bug Report" section of the issue template. Even if an Issue is closed, feel free to comment and add details, it will still
11+
- If you find a bug, please search for it in the [Issues](https://github.com/slackapi/python-slack-sdk/issues), and if it isn't already tracked,
12+
[create a new issue](https://github.com/slackapi/python-slack-sdk/issues/new). Fill out the "Bug Report" section of the issue template. Even if an Issue is closed, feel free to comment and add details, it will still
1313
be reviewed.
1414
- Issues that have already been identified as a bug (note: able to reproduce) will be labelled `bug`.
1515
- If you'd like to submit a fix for a bug, [send a Pull Request](#creating_a_pull_request) and mention the Issue number.
1616
- Include tests that isolate the bug and verifies that it was fixed.
1717

1818
### New Features :bulb:
1919

20-
- If you'd like to add new functionality to this project, describe the problem you want to solve in a [new Issue](https://github.com/slackapi/python-slackclient/issues/new).
20+
- If you'd like to add new functionality to this project, describe the problem you want to solve in a [new Issue](https://github.com/slackapi/python-slack-sdk/issues/new).
2121
- Issues that have been identified as a feature request will be labelled `enhancement`.
2222
- If you'd like to implement the new feature, please wait for feedback from the project
2323
maintainers before spending too much time writing the code. In some cases, `enhancement`s may
@@ -29,7 +29,7 @@ There are many ways you can contribute! :heart:
2929
alternative implementation of something that may have advantages over the way its currently
3030
done, or you have any other change, we would be happy to hear about it!
3131
- If its a trivial change, go ahead and [send a Pull Request](#creating_a_pull_request) with the changes you have in mind.
32-
- If not, [open an Issue](https://github.com/slackapi/python-slackclient/issues/new) to discuss the idea first.
32+
- If not, [open an Issue](https://github.com/slackapi/python-slack-sdk/issues/new) to discuss the idea first.
3333

3434
If you're new to our project and looking for some way to make your first contribution, look for
3535
Issues labelled `good first contribution`.
@@ -38,7 +38,7 @@ Issues labelled `good first contribution`.
3838

3939
For your contribution to be accepted:
4040

41-
- [x] You must have signed the [Contributor License Agreement (CLA)](https://cla-assistant.io/slackapi/python-slackclient).
41+
- [x] You must have signed the [Contributor License Agreement (CLA)](https://cla-assistant.io/slackapi/python-slack-sdk).
4242
- [x] The test suite must be complete and pass.
4343
- [x] The changes must be approved by code review.
4444
- [x] Commits should be atomic and messages must be descriptive. Related issues should be mentioned by Issue number.

.github/maintainers_guide.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ $ brew update
1515
$ brew install pyenv
1616
```
1717

18-
Install necessary Python runtimes for development/testing. You can rely on Travis CI builds for testing with various major versions. https://github.com/slackapi/python-slackclient/blob/main/.travis.yml
18+
Install necessary Python runtimes for development/testing. You can rely on Travis CI builds for testing with various major versions. https://github.com/slackapi/python-slack-sdk/blob/main/.travis.yml
1919

2020
```bash
2121
$ pyenv install -l | grep -v "-e[conda|stackless|pypy]"
@@ -27,7 +27,7 @@ $ pyenv versions
2727
system
2828
3.6.10
2929
3.7.7
30-
* 3.8.5 (set by /path-to-python-slackclient/.python-version)
30+
* 3.8.5 (set by /path-to-python-slack-sdk/.python-version)
3131

3232
$ pyenv rehash
3333
```
@@ -57,7 +57,7 @@ You can rely on Travis CI builds for running the tests on a variety of Python ru
5757

5858
### Testing (Integration Tests with Real Slack APIs)
5959

60-
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-slackclient/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.
60+
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.
6161

6262
```bash
6363
python setup.py run_integration_tests # run all
@@ -97,7 +97,7 @@ You can generate the documentation by running `./docs.sh`.
9797
- Create a GitHub Release. You will select the commit with updated version number (e.g. `version 2.5.0`) to associate with the tag, and name the tag after this version (e.g. `v2.5.0`). This will also serve as a Changelog for the project. Add a description of changes to the Release. Mention Issue and PR #'s and @-mention contributors.
9898

9999
```markdown
100-
Refer to [v{version} milestone](https://github.com/slackapi/python-slackclient/milestone/{TODO}?closed=1) to know the complete list of the issues resolved by this release.
100+
Refer to [v{version} milestone](https://github.com/slackapi/python-slack-sdk/milestone/{TODO}?closed=1) to know the complete list of the issues resolved by this release.
101101

102102
**Updates**
103103

@@ -106,7 +106,7 @@ Refer to [v{version} milestone](https://github.com/slackapi/python-slackclient/m
106106

107107
**All Changes**
108108

109-
https://github.com/slackapi/python-slackclient/compare/{the previous release version tag}...{the release version tag}
109+
https://github.com/slackapi/python-slack-sdk/compare/{the previous release version tag}...{the release version tag}
110110
```
111111

112112
3. (Slack Internal) Communicate the release internally

.github/pull_request_template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@
1515

1616
## Requirements (place an `x` in each `[ ]`)
1717

18-
- [ ] I've read and understood the [Contributing Guidelines](https://github.com/slackapi/python-slackclient/blob/main/.github/contributing.md) and have done my best effort to follow them.
18+
- [ ] I've read and understood the [Contributing Guidelines](https://github.com/slackapi/python-slack-sdk/blob/main/.github/contributing.md) and have done my best effort to follow them.
1919
- [ ] I've read and agree to the [Code of Conduct](https://slackhq.github.io/code-of-conduct).
2020
- [ ] I've run `python setup.py validate` after making the changes.

docs-src/_themes/slack/conf.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# -*- coding: utf-8 -*-
22
#
3-
# python-slackclient documentation build configuration file, created by
3+
# python-slack-sdk documentation build configuration file, created by
44
# sphinx-quickstart on Mon Jun 27 17:36:09 2016.
55
#
66
# This file is execfile()d with the current directory set to its
@@ -146,7 +146,7 @@
146146
# The name for this set of Sphinx documents.
147147
# "<project> v<release> documentation" by default.
148148
#
149-
# html_title = u'python-slackclient v1.0.1'
149+
# html_title = u'python-slack-sdk v1.0.1'
150150

151151
# A shorter title for the navigation bar. Default is the same as html_title.
152152
#
@@ -250,7 +250,7 @@
250250
# html_search_scorer = 'scorer.js'
251251

252252
# Output file base name for HTML help builder.
253-
htmlhelp_basename = 'python-slackclientdoc'
253+
htmlhelp_basename = 'python-slack-sdkdoc'
254254

255255
# -- Options for LaTeX output ---------------------------------------------
256256

@@ -276,7 +276,7 @@
276276
# (source start file, target name, title,
277277
# author, documentclass [howto, manual, or own class]).
278278
latex_documents = [
279-
(master_doc, 'python-slackclient.tex', u'python-slackclient Documentation',
279+
(master_doc, 'python-slack-sdk.tex', u'python-slack-sdk Documentation',
280280
u'Ryan Huber, Jeff Ammons', 'manual'),
281281
]
282282

@@ -312,7 +312,7 @@
312312
# One entry per manual page. List of tuples
313313
# (source start file, name, description, authors, manual section).
314314
man_pages = [
315-
(master_doc, 'python-slackclient', u'python-slackclient Documentation',
315+
(master_doc, 'python-slack-sdk', u'python-slack-sdk Documentation',
316316
[author], 1)
317317
]
318318

@@ -327,8 +327,8 @@
327327
# (source start file, target name, title, author,
328328
# dir menu entry, description, category)
329329
texinfo_documents = [
330-
(master_doc, 'python-slackclient', u'python-slackclient Documentation',
331-
author, 'python-slackclient', 'A basic client for Slack.com, which can optionally connect to the Slack Real Time Messaging (RTM) API.',
330+
(master_doc, 'python-slack-sdk', u'python-slack-sdk Documentation',
331+
author, 'python-slack-sdk', 'A basic client for Slack.com, which can optionally connect to the Slack Real Time Messaging (RTM) API.',
332332
'Miscellaneous'),
333333
]
334334

docs-src/_themes/slack/layout.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@
111111
</span>
112112
<div class="header_nav">
113113
<a
114-
href="https://github.com/SlackAPI/python-slackclient"
114+
href="https://github.com/SlackAPI/python-slack-sdk"
115115
class="btn header_btn float_right"
116116
data-qa="go_to_slack"
117117
>Go to GitHub</a

docs-src/_themes/slack/sidebar.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
<div id="footer">
44

55
<ul id="footer_nav">
6-
<li><a href="https://github.com/SlackAPI/python-slackclient/blob/main/LICENSE">License</a></li>
6+
<li><a href="https://github.com/SlackAPI/python-slack-sdk/blob/main/LICENSE">License</a></li>
77
<li><a href="https://slackhq.github.io/code-of-conduct">Code of Conduct</a></li>
8-
<li><a href="https://github.com/slackapi/python-slackclient/blob/main/.github/contributing.md">Contributing</a></li>
8+
<li><a href="https://github.com/slackapi/python-slack-sdk/blob/main/.github/contributing.md">Contributing</a></li>
99
<li><a href="https://docs.google.com/a/slack-corp.com/forms/d/e/1FAIpQLSfzjVoCM7ohBnjWf7eDYQxzti1EPpinsIJQA5RAUBwJKRUQHg/viewform">Contributor License Agreement</a></li>
1010
</ul>
1111

0 commit comments

Comments
 (0)