#57 WIP reorganize directory structure and edit to readme/docs index

.gitignore

@@ -1,7 +1,8 @@
 # OS Files
 ##########
 .DS_Store
-.vscode
+.vscode/*
+!.vscode/extensions.json
 .ipynb_checkpoints
 *wiki_dump
 *wiki_partitions
@@ -19,6 +20,9 @@ dist
 __pycache__
 # Test coverage output
 .coverage
+# Virtual environment
+venv
+.venv
 
 # NPM Files
 ###########

CHANGELOG.md

@@ -10,18 +10,21 @@ Scribe-Data tries to follow [semantic versioning](https://semver.org/), a MAJOR.
 
 Emojis for the following are chosen based on [gitmoji](https://gitmoji.dev/).
 
+## [Upcoming] Scribe-Data 3.3.0
+
+- The translation process has been updated to allow for translations from non-English languages ([#44](https://github.com/scribe-org/Scribe-Data/issues/44)).
+ <!-- - Scribe-Data now outputs an SQLite table that has keys for target languages for each base language. -->
+ - A process has been created to check and update words that can be translated for each Scribe language.
+ <!-- - English has been added to the data ETL process. -->
+
 ## [Upcoming] Scribe-Data 3.2.0
 
 ### ✨ Features
 
 - The data and process needed for an English keyboard has been added ([#39](https://github.com/scribe-org/Scribe-Data/issues/39)).
  - The Wikidata queries for English have been updated to get all nouns and verbs.
  - Formatting scripts have been written to prepare the queried data and load it into an SQLite database.
- <!-- - English has been added to the data ETL process. -->
 - The data update process has been cleaned up in preparation for future changes to Scribe-Data and to implement better practices.
-- The translation process has been updated to allow for translations from non-English languages ([#44](https://github.com/scribe-org/Scribe-Data/issues/44)).
- <!-- - Scribe-Data now outputs an SQLite table that has keys for target languages for each base language. -->
- - A process has been created to check and update words that can be translated for each Scribe language.
 - Language data was extracted into a JSON file for more succinct code ([#52](https://github.com/scribe-org/Scribe-Data/issues/52)).
 - Language codes are now checked with the package [langcodes](https://github.com/rspeer/langcodes) for easier expansion.
 
@@ -34,6 +37,10 @@ Emojis for the following are chosen based on [gitmoji](https://gitmoji.dev/).
 
 - Tensorflow was removed from the download wiki process to fix build problems on Macs.
 
+### ♻️ Code Refactoring
+
+- Language data processes were moved into the `src/scribe_data/extract_transform/languages` directory to clean up the structure.
+
 ## Scribe-Data 3.1.0
 
 ### ✨ Features

CONTRIBUTING.md

@@ -103,10 +103,12 @@ git remote add upstream https://github.com/scribe-org/Scibe-Data.git
  - `origin` (forked repository)
  - `upstream` (Scribe-Data repository)
 
-2. Use [Anaconda](https://www.anaconda.com/) to create the local development environment within your Scribe-Data directory:
+2. Use [Python venv](https://docs.python.org/3/library/venv.html) to create the local development environment within your Scribe-Data directory:
 
  ```bash
- conda env create -f environment.yml
+ 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
  ```
 
 > [!NOTE]
@@ -215,4 +217,13 @@ Scribe does not accept direct edits to the grammar JSON files as they are source
 
 ## Documentation [`⇧`](#contents)
 
-Documentation is an invaluable way to contribute to coding projects as it allows others to more easily understand the project structure and contribute. Issues related to documentation are marked with the [`documentation`](https://github.com/scribe-org/Scribe-Data/labels/documentation) label.
+The documentation for Scribe-Data can be found at [scribe-data.readthedocs.io](https://scribe-data.readthedocs.io/en/latest/). Documentation is an invaluable way to contribute to coding projects as it allows others to more easily understand the project structure and contribute. Issues related to documentation are marked with the [`documentation`](https://github.com/scribe-org/Scribe-Data/labels/documentation) label.
+
+Use the following commands to build the documentation locally:
+
+```bash
+cd docs
+make html
+```
+
+You can then open `index.html` within `docs/build/html` to check the local version of the documentation.

README.md

@@ -3,7 +3,7 @@
 </div>
 
 [![platform](https://img.shields.io/badge/Wikidata-990000.svg?logo=wikidata&logoColor=ffffff)](https://github.com/scribe-org/Scribe-Data)
-[![rtd](https://img.shields.io/readthedocs/scribe-data.svg?logo=read-the-docs)](http://scribe-data.readthedocs.io/en/latest/)
+[![rtd](https://img.shields.io/readthedocs/scribe-data.svg?label=%20&logo=read-the-docs&logoColor=ffffff)](http://scribe-data.readthedocs.io/en/latest/)
 [![issues](https://img.shields.io/github/issues/scribe-org/Scribe-Data?label=%20&logo=github)](https://github.com/scribe-org/Scribe-Data/issues)
 [![language](https://img.shields.io/badge/Python%203-306998.svg?logo=python&logoColor=ffffff)](https://github.com/scribe-org/Scribe-Data/blob/main/CONTRIBUTING.md)
 [![pypi](https://img.shields.io/pypi/v/scribe-data.svg?label=%20&color=4B8BBE)](https://pypi.org/project/scribe-data/)
@@ -116,10 +116,12 @@ git remote add upstream https://github.com/scribe-org/Scibe-Data.git
  - `origin` (forked repository)
  - `upstream` (Scribe-Data repository)
 
-2. Use [Anaconda](https://www.anaconda.com/) to create the local development environment within your Scribe-Data directory:
+2. Use [Python venv](https://docs.python.org/3/library/venv.html) to create the local development environment within your Scribe-Data directory:
 
  ```bash
- conda env create -f environment.yml
+ 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
  ```
 
 > [!NOTE]
@@ -156,7 +158,7 @@ The following table shows the supported languages and the amount of data availab
 
 <strong>2024</strong>
 
-- Feb: [Presentation slides](https://docs.google.com/presentation/d/1lMhYiQx1R99SVGhbikUGjOVaFgPPASvbzM2Bsu3NXSg/edit?usp=sharing) for Scribe's participation at the [Wikimedia Tech Safari Program](https://www.mediawiki.org/wiki/Wikimedia_Tech_Safari_Program)
+- February: [Presentation slides](https://docs.google.com/presentation/d/1lMhYiQx1R99SVGhbikUGjOVaFgPPASvbzM2Bsu3NXSg/edit?usp=sharing) for Scribe's participation at the [Wikimedia Tech Safari Program](https://www.mediawiki.org/wiki/Wikimedia_Tech_Safari_Program)
 
 <strong>2023</strong>
 

docs/requirements.txt

@@ -1,5 +1,5 @@
 m2r2
 numpydoc
 scribe-data
-sphinx<7.0.0
+sphinx
 sphinx_rtd_theme

docs/source/conf.py

@@ -13,6 +13,11 @@
 import os
 import sys
 
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+#
+import sphinx_rtd_theme
+
 sys.path.insert(0, os.path.abspath(".."))
 
 # -- Project information -----------------------------------------------------
@@ -85,11 +90,6 @@
 
 # -- Options for HTML output ----------------------------------------------
 
-# The theme to use for HTML and HTML Help pages. See the documentation for
-# a list of builtin themes.
-#
-import sphinx_rtd_theme
-
 html_theme = "sphinx_rtd_theme"
 
 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

docs/source/index.rst

@@ -9,7 +9,7 @@
 .. |platform| image:: https://img.shields.io/badge/Wikidata-990000.svg?logo=wikidata&logoColor=ffffff
  :target: https://github.com/scribe-org/Scribe-Data
 
-.. |rtd| image:: https://img.shields.io/readthedocs/scribe-data.svg?logo=read-the-docs
+.. |rtd| image:: https://img.shields.io/readthedocs/scribe-data.svg?label=%20&logo=read-the-docs&logoColor=ffffff
  :target: http://scribe-datareadthedocs.io/en/latest/
 
 .. |issues| image:: https://img.shields.io/github/issues/scribe-org/Scribe-Data?label=%20&logo=github

docs/source/notes.rst

@@ -1,4 +1,4 @@
-.. mdinclude:: _internal/CONTRIBUTING_NO_BACK_LINKS.md
+.. mdinclude:: ../../.github/docs/CONTRIBUTING_NO_BACK_LINKS.md
 
 License
 =======