Merge branch 'main' into translate-from-russian

.vscode/extensions.json

@@ -1,3 +1,7 @@
 {
-  "recommendations": ["blokhinnv.wikidataqidlabels"]
+  "recommendations": [
+    "blokhinnv.wikidataqidlabels",
+    "charliermarsh.ruff",
+    "streetsidesoftware.code-spell-checker"
+  ]
 }

CHANGELOG.md

@@ -16,6 +16,15 @@ Emojis for the following are chosen based on [gitmoji](https://gitmoji.dev/).
   - Scribe-Data now outputs an SQLite table that has keys for target languages for each base language. -->
 <!-- - English has been added to the data ETL process. -->
 
+- The documentation has been given a new layout with the logo in the top left ([#90](https://github.com/scribe-org/Scribe-Data/issues/90)).
+- The documentation now has links to the code at the top of each page ([#91](https://github.com/scribe-org/Scribe-Data/issues/91)).
+
+### ♻️ Code Refactoring
+
+- The `_update_files` directory was renamed `update_files` as these files are used in non-internal manners now ([#57](https://github.com/scribe-org/Scribe-Data/issues/57)).
+- A common function has been created to map Wikidata ids to noun genders ([#69](https://github.com/scribe-org/Scribe-Data/issues/69)).
+- Code formatting was shifted from [black](https://github.com/psf/black) to [Ruff](https://github.com/astral-sh/ruff).
+
 ## Scribe-Data 3.2.2
 
 - Minor fixes to documentation index and file docstrings to fix errors.

CONTRIBUTING.md

@@ -69,6 +69,21 @@ Scribe is very open to contributions from people in the early stages of their co
 
 ## Development environment [`⇧`](#contents)
 
+> [!IMPORTANT]
+>
+> <details><summary>Suggested IDE extensions</summary>
+>
+> <p>
+>
+> VS Code
+>
+> - [blokhinnv.wikidataqidlabels](https://marketplace.visualstudio.com/items?itemName=blokhinnv.wikidataqidlabels)
+> - [charliermarsh.ruff](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff)
+> - [streetsidesoftware.code-spell-checker](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker)
+
+> </p>
+> </details>
+
 The development environment for Scribe-Data can be installed via the following steps:
 
 1. [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the [Scribe-Data repo](https://github.com/scribe-org/Scribe-Data), clone your fork, and configure the remotes:
@@ -105,11 +120,26 @@ git remote add upstream https://github.com/scribe-org/Scribe-Data.git
 
 2. Use [Python venv](https://docs.python.org/3/library/venv.html) to create the local development environment within your Scribe-Data directory:
 
-   ```bash
-   python3 -m venv venv  # make an environment venv
-   pip install --upgrade pip  # make sure that pip is at the latest version
-   pip install -r requirements.txt  # install dependencies
-   ```
+- On Unix or MacOS, run:
+
+  ```bash
+  python3 -m venv venv  # make an environment named venv
+  source venv/bin/activate # activate the environment
+  ```
+
+- On Windows (using Command Prompt), run:
+
+  ```bash
+  python -m venv venv
+  venv\Scripts\activate.bat
+  ```
+
+After activating the virtual environment, install the required dependencies by running:
+
+```bash
+pip install --upgrade pip  # make sure that pip is at the latest version
+pip install -r requirements.txt  # install dependencies
+```
 
 > [!NOTE]
 > Feel free to contact the team in the [Data room on Matrix](https://matrix.to/#/#ScribeData:matrix.org) if you're having problems getting your environment setup!

README.md

@@ -12,7 +12,7 @@
 [![coc](https://img.shields.io/badge/Contributor%20Covenant-ff69b4.svg)](https://github.com/scribe-org/Scribe-Data/blob/main/.github/CODE_OF_CONDUCT.md)
 [![mastodon](https://img.shields.io/badge/Mastodon-6364FF.svg?logo=mastodon&logoColor=ffffff)](https://wikis.world/@scribe)
 [![matrix](https://img.shields.io/badge/Matrix-000000.svg?logo=matrix&logoColor=ffffff)](https://matrix.to/#/#scribe_community:matrix.org)
-[![codestyle](https://img.shields.io/badge/black-000000.svg)](https://github.com/psf/black)
+[![codestyle](https://img.shields.io/badge/Ruff-26122F.svg?logo=Ruff)](https://github.com/astral-sh/ruff)
 
 ## Wikidata and Wikipedia language data extraction
 
@@ -46,7 +46,7 @@ The main data update process in [update_data.py](https://github.com/scribe-org/S
 Running [update_data.py](https://github.com/scribe-org/Scribe-Data/blob/main/src/scribe_data/extract_transform/update_data.py) is done via the following CLI command:
 
 ```bash
-python src/scribe_data/extract_transform/update_data.py
+python3 src/scribe_data/extract_transform/update_data.py
 ```
 
 The ultimate goal is that this repository will house language packs that are periodically updated with new [Wikidata](https://www.wikidata.org/) lexicographical data and data from other sources. These packs would then be available to download by users of Scribe applications.
@@ -90,6 +90,21 @@ Scribe does not accept direct edits to the grammar JSON files as they are source
 
 # Environment Setup [`⇧`](#contents)
 
+> [!IMPORTANT]
+>
+> <details><summary>Suggested IDE extensions</summary>
+>
+> <p>
+>
+> VS Code
+>
+> - [blokhinnv.wikidataqidlabels](https://marketplace.visualstudio.com/items?itemName=blokhinnv.wikidataqidlabels)
+> - [charliermarsh.ruff](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff)
+> - [streetsidesoftware.code-spell-checker](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker)
+>
+> </p>
+> </details>
+
 The development environment for Scribe-Data can be installed via the following steps:
 
 1. [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the [Scribe-Data repo](https://github.com/scribe-org/Scribe-Data), clone your fork, and configure the remotes:
@@ -126,24 +141,26 @@ git remote add upstream https://github.com/scribe-org/Scribe-Data.git
 
 2. Use [Python venv](https://docs.python.org/3/library/venv.html) to create the local development environment within your Scribe-Data directory:
 
- - On Unix or MacOS, run:   
+- On Unix or MacOS, run:
+
+  ```bash
+  python3 -m venv venv  # make an environment named venv
+  source venv/bin/activate # activate the environment
+  ```
 
-     ```bash
-     python3 -m venv venv  # make an environment named venv
-     source venv/bin/activate # activate the environment
-     ```
 - On Windows (using Command Prompt), run:
-
-    ```bash
-    python -m venv venv
-    venv\Scripts\activate.bat
-    ```
+
+  ```bash
+  python -m venv venv
+  venv\Scripts\activate.bat
+  ```
+
 After activating the virtual environment, install the required dependencies by running:
 
-   ```bash
-   pip install --upgrade pip  # make sure that pip is at the latest version
-   pip install -r requirements.txt  # install dependencies
-   ```
+```bash
+pip install --upgrade pip  # make sure that pip is at the latest version
+pip install -r requirements.txt  # install dependencies
+```
 
 > [!NOTE]
 > Feel free to contact the team in the [Data room on Matrix](https://matrix.to/#/#ScribeData:matrix.org) if you're having problems getting your environment setup!