diff options
| author | 2021-05-16 18:44:44 +0100 | |
|---|---|---|
| committer | 2021-05-16 18:44:44 +0100 | |
| commit | c3c94a5988bbcf5e42d12b7ca4580fbe65bf2652 (patch) | |
| tree | 01ee2e9c58afd5fa2868c39c7fb993596af1ee66 /pydis_site/apps/content/resources/guides | |
| parent | Fixes Typo In Contrib Guide (diff) | |
| parent | Merge pull request #412 from Transfusion/fix_327 (diff) | |
Merge branch 'main' into reword-contrib-guides
Diffstat (limited to 'pydis_site/apps/content/resources/guides')
4 files changed, 31 insertions, 20 deletions
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 4432236e..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 @@ -16,23 +16,30 @@ 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`. - -4. In the popup window, click `Pipenv Environment`, make sure `Install packages from Pipfile` is checked, then click `OK`. - -5. PyCharm will automatically install the packages required into a virtual environment. - +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`. + +5. If installing dependencies for the site, click `Pipenv Environment`, otherwise, click `Poetry Environment`, then click `OK`. + +6. PyCharm will automatically install the packages required into a virtual environment. + --- ## 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 ``` --- 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` | | |