From 9420ec1cb345bef610dbb566098f82d6839e9eb7 Mon Sep 17 00:00:00 2001 From: swfarnsworth Date: Fri, 14 May 2021 15:08:26 -0400 Subject: Changed rules to those agreed upon in a prior staff meeting. --- pydis_site/apps/content/resources/rules.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) (limited to 'pydis_site/apps') diff --git a/pydis_site/apps/content/resources/rules.md b/pydis_site/apps/content/resources/rules.md index 27f03f07..d5db1203 100644 --- a/pydis_site/apps/content/resources/rules.md +++ b/pydis_site/apps/content/resources/rules.md @@ -5,13 +5,15 @@ icon: fab fa-discord --- We have a small but strict set of rules on our server. Please read over them and take them on board. If you don't understand a rule or need to report an incident, please send a direct message to @ModMail! -> 1. Follow the [Discord Community Guidelines](https://discordapp.com/guidelines) and [Terms Of Service](https://discordapp.com/terms). -> 2. Follow the [Python Discord Code of Conduct](/pages/code-of-conduct/). -> 3. Listen to and respect staff members and their instructions. -> 4. This is an English-speaking server, so please speak English to the best of your ability. -> 5. Do not provide or request help on projects that may break laws, breach terms of services, be considered malicious or inappropriate. Do not help with ongoing exams. Do not provide or request solutions for graded assignments, although general guidance is okay. -> 6. No spamming or unapproved advertising, including requests for paid work. Open-source projects can be shared with others in #python-general and code reviews can be asked for in a help channel. -> 7. Keep discussions relevant to channel topics and guidelines. +> 1. Follow the [Python Discord Code of Conduct](/pages/code-of-conduct/). +> 2. Follow the [Discord Community Guidelines](https://discordapp.com/guidelines) and [Terms of Service](https://discordapp.com/terms). +> 3. Respect staff members and listen to their instructions. +> 4. Use English to the best of your ability. Be polite if someone speaks English imperfectly. +> 5. Do not provide or request help on projects that may break laws, breach terms of services, or are malicious or inappropriate. +> 6. Do not post unapproved advertising. +> 7. Keep discussions relevant to the channel topic. Each channel's description tells you the topic. +> 8. Do not help with ongoing exams. When helping with homework, help people learn how to do the assignment without doing it for them. +> 9. Do not offer or ask for paid work of any kind. # Nickname Policy -- cgit v1.2.3 From c7c354198212ac7b427933028d08a63966291786 Mon Sep 17 00:00:00 2001 From: swfarnsworth Date: Sat, 15 May 2021 09:30:53 -0400 Subject: Fixed whitespace issue raised by linter. --- pydis_site/apps/content/resources/rules.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'pydis_site/apps') diff --git a/pydis_site/apps/content/resources/rules.md b/pydis_site/apps/content/resources/rules.md index d5db1203..05d0e93a 100644 --- a/pydis_site/apps/content/resources/rules.md +++ b/pydis_site/apps/content/resources/rules.md @@ -6,7 +6,7 @@ icon: fab fa-discord We have a small but strict set of rules on our server. Please read over them and take them on board. If you don't understand a rule or need to report an incident, please send a direct message to @ModMail! > 1. Follow the [Python Discord Code of Conduct](/pages/code-of-conduct/). -> 2. Follow the [Discord Community Guidelines](https://discordapp.com/guidelines) and [Terms of Service](https://discordapp.com/terms). +> 2. Follow the [Discord Community Guidelines](https://discordapp.com/guidelines) and [Terms of Service](https://discordapp.com/terms). > 3. Respect staff members and listen to their instructions. > 4. Use English to the best of your ability. Be polite if someone speaks English imperfectly. > 5. Do not provide or request help on projects that may break laws, breach terms of services, or are malicious or inappropriate. -- cgit v1.2.3 From 9b319e1bb8d83687dd2e7450f2483151a72f206b Mon Sep 17 00:00:00 2001 From: Chris Date: Sat, 15 May 2021 14:53:37 +0100 Subject: Update rules viewset This is to reflect the recent changes made to the server rules. --- pydis_site/apps/api/views.py | 28 ++++++++++++++++------------ 1 file changed, 16 insertions(+), 12 deletions(-) (limited to 'pydis_site/apps') diff --git a/pydis_site/apps/api/views.py b/pydis_site/apps/api/views.py index 0d126051..816463f6 100644 --- a/pydis_site/apps/api/views.py +++ b/pydis_site/apps/api/views.py @@ -121,30 +121,34 @@ class RulesView(APIView): return Response([ ( - f"Follow the {discord_community_guidelines} and {discord_tos}." + f"Follow the {pydis_coc}." ), ( - f"Follow the {pydis_coc}." + f"Follow the {discord_community_guidelines} and {discord_tos}." ), ( - "Listen to and respect staff members and their instructions." + "Respect staff members and listen to their instructions." ), ( - "This is an English-speaking server, " - "so please speak English to the best of your ability." + "Use English to the best of your ability. " + "Be polite if someone speaks English imperfectly." ), ( "Do not provide or request help on projects that may break laws, " - "breach terms of services, be considered malicious or inappropriate. " - "Do not help with ongoing exams. Do not provide or request solutions " - "for graded assignments, although general guidance is okay." + "breach terms of services, or are malicious or inappropriate." + ), + ( + "Do not post unapproved advertising." + ), + ( + "Keep discussions relevant to the channel topic. " + "Each channel's description tells you the topic." ), ( - "No spamming or unapproved advertising, including requests for paid work. " - "Open-source projects can be shared with others in #python-general and " - "code reviews can be asked for in a help channel." + "Do not help with ongoing exams. When helping with homework, " + "help people learn how to do the assignment without doing it for them." ), ( - "Keep discussions relevant to channel topics and guidelines." + "Do not offer or ask for paid work of any kind." ), ]) -- cgit v1.2.3 From 99843bcd2f362c717cc72ffa914f1edf8799aba7 Mon Sep 17 00:00:00 2001 From: swfarnsworth Date: Sat, 15 May 2021 12:56:09 -0400 Subject: Fix typo; 'be come' -> 'become' --- pydis_site/apps/content/resources/frequently-asked-questions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'pydis_site/apps') diff --git a/pydis_site/apps/content/resources/frequently-asked-questions.md b/pydis_site/apps/content/resources/frequently-asked-questions.md index ed797532..90e690b8 100644 --- a/pydis_site/apps/content/resources/frequently-asked-questions.md +++ b/pydis_site/apps/content/resources/frequently-asked-questions.md @@ -13,7 +13,7 @@ This FAQ is aimed at answering questions about the Python Discord community. If #### **Q: How do I get the helper role / become moderator / join staff?** -There are no applications to be come a Helper, Moderator, Admin, or other staff role. +There are no applications to become a Helper, Moderator, Admin, or other staff role. To become a Helper, which is our base staff role, people are nominated by a staff member and are later put up to a vote by Moderators, Admins, and Owners. If the candidate received enough votes unanimously, then we offer them the Helper role. This whole process takes place in channels only viewable to staff members. -- cgit v1.2.3 From 2fb15fef7e2475437af82084d1b994d1d7649f69 Mon Sep 17 00:00:00 2001 From: swfarnsworth Date: Sat, 15 May 2021 13:00:13 -0400 Subject: Replace references to Zoot with Dave, per the rebranding of that bot. --- pydis_site/apps/content/resources/frequently-asked-questions.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) (limited to 'pydis_site/apps') diff --git a/pydis_site/apps/content/resources/frequently-asked-questions.md b/pydis_site/apps/content/resources/frequently-asked-questions.md index 90e690b8..8b9945aa 100644 --- a/pydis_site/apps/content/resources/frequently-asked-questions.md +++ b/pydis_site/apps/content/resources/frequently-asked-questions.md @@ -55,10 +55,9 @@ There isn't a way to invite `@Python` to other servers. If you are interested in `@Python` though, you can host your own instance of it. The entire project is open source and can be found on [our github](https://github.com/python-discord/bot). -#### **Q: What is the Zoot bot?** +#### **Q: Who is the Dave bot?** -Zoot is an instance of [Metricity](https://github.com/python-discord/metricity). -It collects advanced metrics about the usage of the server. +Dave, in addition to [learning to code](https://www.youtube.com/watch?v=ZH26PuX3re0), is running an instance of [Metricity](https://github.com/python-discord/metricity), which collects advanced metrics about the usage of the server. Message content is not stored or collected. You can view what data we collect in our [data privacy policy](/pages/privacy/). -- cgit v1.2.3 From 5a86952a64ad93988777289e97b7e40d6e164171 Mon Sep 17 00:00:00 2001 From: ToxicKidz Date: Sun, 16 May 2021 12:02:30 -0400 Subject: chore: Update sir-lancebot's env var reference --- .../pydis-guides/contributing/sir-lancebot/env-var-reference.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'pydis_site/apps') diff --git a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/sir-lancebot/env-var-reference.md b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/sir-lancebot/env-var-reference.md index 47f01f44..5c472eb2 100644 --- a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/sir-lancebot/env-var-reference.md +++ b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/sir-lancebot/env-var-reference.md @@ -15,6 +15,7 @@ The following variables are needed for running Sir Lancebot: | `CHANNEL_ANNOUNCEMENTS` | ID of the #announcements channel | | `CHANNEL_DEVLOG` | ID of the #dev-log channel | | `CHANNEL_COMMUNITY_BOT_COMMANDS` | ID of the #sir-lancebot-commands channel | +| `CHANNEL_REDDIT` | ID of the #reddit channel | --- ## Debug Variables @@ -49,9 +50,10 @@ If you will be working with an external service, you might have to set one of th | `YOUTUBE_API_KEY` | An OAuth Key or Token are required for API access. [Docs](https://developers.google.com/youtube/v3/docs#calling-the-api) | | `TMDB_API_KEY` | Required for API access. [Docs](https://developers.themoviedb.org/3/getting-started/introduction) | | `NASA_API_KEY` | Required for API access. [Docs](https://api.nasa.gov/) | -| `IGDB_API_KEY` | Required for API access. A Twitch account is needed. [Docs](https://api-docs.igdb.com/#about) | | `WOLFRAM_API_KEY` | | | `UNSPLASH_KEY` | Required for API access. Use the `access_token` given by Unsplash. [Docs](https://unsplash.com/documentation) | +| `IGDB_CLIENT_ID` | OAuth2 client ID for authenticating with the [IGDB API](https://api-docs.igdb.com/) | +| `IGDB_CLIENT_SECRET` | OAuth2 secret for authenticating with the IGDB API. *Leave empty if you're not using the IGDB API.* | --- ## Seasonal Cogs @@ -65,7 +67,9 @@ These variables might come in handy while working on certain cogs: | Advent of Code | `AOC_IGNORED_DAYS` | Comma seperated list of days to ignore while calulating score. | | Advent of Code | `AOC_YEAR` | Debug variable to change the year used for AoC. | | Advent of Code | `AOC_CHANNEL_ID` | The ID of the #advent-of-code channel | +| Advent of Code | `AOC_COMMANDS_CHANNEL_ID` | The ID of the #advent-of-code-commands channel | | Advent of Code | `AOC_FALLBACK_SESSION` | | +| Advent of Code | `AOC_SESSION_COOKIE` | | | Valentines | `LOVEFEST_ROLE_ID` | | | Wolfram | `WOLFRAM_USER_LIMIT_DAY` | | | Wolfram | `WOLFRAM_GUILD_LIMIT_DAY` | | -- cgit v1.2.3 From ab75c82c297a81e7a080d9d9a205ff3e99116be5 Mon Sep 17 00:00:00 2001 From: Hassan Abouelela Date: Sun, 16 May 2021 19:05:03 +0300 Subject: Fixes Broken Images In Dependency Guide --- .../installing-project-dependencies.md | 15 ++++++++------- .../content/contributing/pycharm_interpreter.png | Bin 52028 -> 21696 bytes .../images/content/contributing/pycharm_pipenv.png | Bin 35997 -> 18513 bytes .../contributing/pycharm_pipenv_success.png | Bin 119232 -> 27705 bytes 4 files changed, 8 insertions(+), 7 deletions(-) (limited to 'pydis_site/apps') diff --git a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/installing-project-dependencies.md b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/installing-project-dependencies.md index 4432236e..7881c07d 100644 --- a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/installing-project-dependencies.md +++ b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/installing-project-dependencies.md @@ -16,13 +16,14 @@ You should have already cloned your fork as described in [**Cloning a Repository ## Installing dependencies with PyCharm 1. Load up your project in PyCharm. -2. Go to the Project Settings by clicking `File`, then `Settings...`. Alternatively, use the shortcut key `Ctrl+Alt+S`. -3. Navigate to `Project Interpreter`, then click the gear icon and click `Add`. -![PyCharm Interpreter Settings](/static/images/wiki/contributing/pycharm_interpreter.png) -4. In the popup window, click `Pipenv Environment`, make sure `Install packages from Pipfile` is checked, then click `OK`. -![PyCharm Pipenv Environment](/static/images/wiki/contributing/pycharm_pipenv.png) -5. PyCharm will automatically install the packages required into a virtual environment. -![PyCharm Project Interpreter](/static/images/wiki/contributing/pycharm_pipenv_success.png) +2. Go to the Project Settings by clicking `File`, then `Settings...`. Alternatively, use the shortcut key: `Ctrl+Alt+S` (`command+comma` on Mac OS). +3. Install the [poetry plugin](https://plugins.jetbrains.com/plugin/14307-poetry). (**Note:** This is not required for the site) +4. Navigate to `Project Interpreter`, then click the gear icon and click `Add`. +![PyCharm Interpreter Settings](/static/images/content/contributing/pycharm_interpreter.png) +5. If installing dependencies for the site, click `Pipenv Environment`, otherwise, click `Poetry Environment`, then click `OK`. +![PyCharm Pipenv Environment](/static/images/content/contributing/pycharm_pipenv.png) +6. PyCharm will automatically install the packages required into a virtual environment. +![PyCharm Project Interpreter](/static/images/content/contributing/pycharm_pipenv_success.png) --- diff --git a/pydis_site/static/images/content/contributing/pycharm_interpreter.png b/pydis_site/static/images/content/contributing/pycharm_interpreter.png index cb757f84..66a0dc7f 100644 Binary files a/pydis_site/static/images/content/contributing/pycharm_interpreter.png and b/pydis_site/static/images/content/contributing/pycharm_interpreter.png differ diff --git a/pydis_site/static/images/content/contributing/pycharm_pipenv.png b/pydis_site/static/images/content/contributing/pycharm_pipenv.png index feb9b1d7..5d6620ee 100644 Binary files a/pydis_site/static/images/content/contributing/pycharm_pipenv.png and b/pydis_site/static/images/content/contributing/pycharm_pipenv.png differ diff --git a/pydis_site/static/images/content/contributing/pycharm_pipenv_success.png b/pydis_site/static/images/content/contributing/pycharm_pipenv_success.png index 03fa3244..65ac2040 100644 Binary files a/pydis_site/static/images/content/contributing/pycharm_pipenv_success.png and b/pydis_site/static/images/content/contributing/pycharm_pipenv_success.png differ -- cgit v1.2.3 From 636281d27df0113ea5e2be3c1ad7d9d77cd28271 Mon Sep 17 00:00:00 2001 From: Hassan Abouelela Date: Sun, 16 May 2021 19:08:39 +0300 Subject: Migrates Sir Lancebot And Python To Poetry Updates the Python and Sir Lancebot guides to use poetry. Updates the dependency guide to include poetry, and explain when each dependency manager should be used. --- .../resources/guides/pydis-guides/contributing/bot.md | 8 ++++---- .../contributing/installing-project-dependencies.md | 14 ++++++++++---- .../guides/pydis-guides/contributing/sir-lancebot.md | 8 ++++---- 3 files changed, 18 insertions(+), 12 deletions(-) (limited to 'pydis_site/apps') diff --git a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/bot.md b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/bot.md index 9e0f323a..741bf28e 100644 --- a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/bot.md +++ b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/bot.md @@ -6,9 +6,9 @@ toc: 1 --- # Requirements -* [Python 3.8](https://www.python.org/downloads/) -* [Pipenv](https://github.com/pypa/pipenv#installation) - * `pip install pipenv` +* [Python 3.9](https://www.python.org/downloads/) +* [Poetry](https://github.com/python-poetry/poetry#installation) + * `pip install poetry` * [Git](https://git-scm.com/downloads) * [Windows](https://git-scm.com/download/win) * [MacOS](https://git-scm.com/download/mac) or `brew install git` @@ -181,7 +181,7 @@ Running on the host is particularly useful if you wish to debug the bot. The site has to have been started somehow beforehand. ```shell -pipenv run start +poetry run task start ``` --- diff --git a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/installing-project-dependencies.md b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/installing-project-dependencies.md index 7881c07d..ba5b3d1b 100644 --- a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/installing-project-dependencies.md +++ b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/installing-project-dependencies.md @@ -28,12 +28,18 @@ You should have already cloned your fork as described in [**Cloning a Repository --- ## Installing dependencies with the command line -1. Make sure you are in the project directory. -2. Install project and development dependencies: +1. Make sure you are in the root project directory. This directory will always have a file titled `README.md`. +2. Install project and development dependencies. Remember to also set up pre-commit hooks to ensure your pushed commits will never fail linting. +--- + +- Site: ```shell $ pipenv sync --dev +$ pipenv run precommit ``` -* Remember to also set up pre-commit hooks to ensure your pushed commits will never fail linting: + +- Other projects: ```shell -$ pipenv run precommit +$ poetry install +$ poetry run task precommit ``` diff --git a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/sir-lancebot.md b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/sir-lancebot.md index 4ff98095..601cfa4a 100644 --- a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/sir-lancebot.md +++ b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/sir-lancebot.md @@ -9,8 +9,8 @@ toc: 1 --- # Requirements -- [Python 3.8](https://www.python.org/downloads/) -- [Pipenv](https://github.com/pypa/pipenv/blob/master/docs/install.rst#-installing-pipenv) +- [Python 3.9](https://www.python.org/downloads/) +- [Poetry](https://github.com/python-poetry/poetry#installation) - [Git](https://git-scm.com/downloads) - [Windows Installer](https://git-scm.com/download/win) - [MacOS Installer](https://git-scm.com/download/mac) or `brew install git` @@ -101,10 +101,10 @@ If you get any Docker related errors, reference the [Possible Issues](./docker/p {: .notification .is-warning } ## Run on the host -After installing project dependencies use the pipenv command `pipenv run start` in the project root. +After installing project dependencies use the poetry command `poetry run task start` in the project root. ```shell -$ pipenv run start +$ poetry run task start ``` --- -- cgit v1.2.3