diff --git a/.gitignore b/.gitignore
index 45b97c6..c908628 100644
--- a/.gitignore
+++ b/.gitignore
@@ -61,4 +61,7 @@ MANIFEST
 
 ## == JAVASCRIPT ==
 
-node_modules/
\ No newline at end of file
+node_modules/
+
+## == DOCUMENTATION ==
+site/
\ No newline at end of file
diff --git a/README.md b/README.md
index 88a5f35..42d9bc5 100644
--- a/README.md
+++ b/README.md
@@ -1,215 +1,44 @@
-# WordPress Site Extractor
+# WPextract - WordPress Site Extractor
 
-Processes an API dump of a WordPress site into a dataset, including identifying parallel multilingual articles, and resolving internal links and media.
+**WPextract is a tool to create datasets from WordPress sites.**
+
+- Archives posts, pages, tags, categories, media (including files), comments, and users
+- Uses the WordPress API to guarantee 100% accurate and complete content
+- Resolves internal links and media to IDs
+- Automatically parses multilingual sites to create parallel datasets
 
 > [!NOTE]  
 > This software was developed for our EMNLP 2023 paper [_Analysing State-Backed Propaganda Websites: a New Dataset and Linguistic Study_](https://aclanthology.org/2023.emnlp-main.349/). The code has been updated since the paper was written; for archival purposes, the precise version used for the study is [available on Zenodo](https://zenodo.org/records/10008086).
 
-## Referencing
-
-We'd love to hear about your use of our tool, you can [email us](mailto:frheppell1@sheffield.ac.uk) to let us know! Feel free to create issues and/or pull requests for new features or bugs.
-
-If you use this tool in published work, please cite [our EMNLP paper](https://aclanthology.org/2023.emnlp-main.349/):
-
-
-<details>
-   <summary>BibTeX Citation</summary>
-   
-```bibtex
-@inproceedings{heppell-etal-2023-analysing,
-    title = "Analysing State-Backed Propaganda Websites: a New Dataset and Linguistic Study",
-    author = "Heppell, Freddy  and
-      Bontcheva, Kalina  and
-      Scarton, Carolina",
-    editor = "Bouamor, Houda  and
-      Pino, Juan  and
-      Bali, Kalika",
-    booktitle = "Proceedings of the 2023 Conference on Empirical Methods in Natural Language Processing",
-    month = dec,
-    year = "2023",
-    address = "Singapore",
-    publisher = "Association for Computational Linguistics",
-    url = "https://aclanthology.org/2023.emnlp-main.349",
-    pages = "5729--5741",
-    doi = "10.18653/v1/2023.emnlp-main.349"
-}
-```
-</details>
-
-
-## Installing
-
-WordPress Site Extractor is currently not available from PyPI, but can instead be installed from a prebuilt wheel.
-
-1. Go to the [latest release](https://github.com/GateNLP/wordpress-site-extractor/releases/latest) and download the `.whl` file
-2. Create a new Python 3.9 or greater virtual environment
-3. Install the package with `pip install /path/to/wp_site_extractor-x.y.z-py3-none-any.whl`
-4. Run with the `wpextract` command
-   
-### Installing Development Environment
-
-**Prerequisites**:
-
-- Python 3.9 or greater
-- [Poetry](https://python-poetry.org/)
-
-1. Clone the repository
-2. Run `poetry install`
-   - You may need to first run `poetry env use /path/to/python` if Python 3.8 is not on your path
-3. Run the CLI with `poetry run wpextract`
-
-## Input Format
-
-This tool takes a dump of the API JSON and (optionally) HTML pages of the site.
-
-### API Dump
-
-The dump should be in a 'merged pages' format, i.e. the pages of the list endpoint should be iterated and each page merged together into one list. This can be done by a tool such as [WPJSONScraper](https://github.com/freddyheppell/wp-json-scraper).
-
-The following files should be placed in a directory. Their names may be prefixed by a consistent string (e.g. to record the date).
-
-| File Name         | Endpoint                               |
-|-------------------|----------------------------------------|
-| `categories.json` | [`/wp/v2/categories`][categories_path] |
-| `comments.json`   | [`/wp/v2/comments`][comments_path]     |
-| `media.json`      | [`/wp/v2/media`][media_path]           |
-| `pages.json`      | [`/wp/v2/pages`][pages_path]           |
-| `posts.json`      | [`/wp/v2/posts`][posts_path]           |
-| `tags.json`       | [`/wp/v2/tags`][tags_path]             |
-| `users.json`      | [`/wp/v2/users`][users_path]           |
-
-[categories_path]: https://developer.wordpress.org/rest-api/reference/categories/#list-categories
-[comments_path]: https://developer.wordpress.org/rest-api/reference/comments/#list-comments
-[media_path]: https://developer.wordpress.org/rest-api/reference/media/#list-media
-[pages_path]: https://developer.wordpress.org/rest-api/reference/pages/#list-pages
-[posts_path]: https://developer.wordpress.org/rest-api/reference/posts/#list-posts
-[tags_path]: https://developer.wordpress.org/rest-api/reference/tags/#list-tags
-[users_path]: https://developer.wordpress.org/rest-api/reference/users/#list-users
-
-### HTML Scrape
-
-This should be a scrape of the site's posts (at least), which will be used to extract data which is not present in the API response.
-
-Currently, this is only used to extract translations of posts. If the site you are scraping does not have translations, the scrape is not required and an empty directory can be used.
-
-An example of an easy way to do this (given the `posts.json` file described above) is
-
-```shell
-cat posts.json | jq -r '.[] | .link' > url_list.txt
-touch rejected.log
-wget --adjust-extension --input-file=url_list.txt --random-wait --force-directories --rejected-log=failed.log
-```
-
-You could also use a tool such as [Ultimate Sitemap Parser](https://github.com/mediacloud/ultimate-sitemap-parser) to generate a list of URLs from the sitemap and then use `wget`.
-
-```python
-from usp.tree import sitemap_tree_for_homepage
-tree = sitemap_tree_for_homepage('https://example.org')
-urls = set([page.url for page in tree.all_pages()])
-with open('url_list.txt') as f:
-    f.write('\n'.join(list(urls)))
-```
-
-Finally, you could run a standard recursive `wget` scrape, although this is less certain to get all the content needed.
+## Quickstart
 
-## Running the tool
+See the [complete documentation](#) for more detailed usage.
 
-To run the tool, use the `main.py` script:
+1. Install with `pipx`
+    ```shell-session
+    $ pipx install wpextract
+    ```
+2. Download site data
+    ```shell-session
+    $ wpextract dl "https://example.org" out_dl
+    ```
+3. Process into a dataset
+    ```shell-session
+    $ wpextract extract out_dl out_data
+    ```
 
-```shell
-wpextract path_to_json/ path_to_scrape/ path_to_out/
-```
+## About WPextract
 
-### JSON Prefixes
+WPextract was built by [Freddy Heppell](https://freddyheppell.com) of the [GATE Project](https://gate.ac.uk) at the [School of Computer Science, University of Sheffield](https://sheffield.ac.uk/cs), originally created to scrape mis/disinformation websites for research.
 
-If the JSON files have a name prefix (e.g. `20221209-exampleorg-posts.json`, use the `--json-prefix` argument:
+## License
 
-```shell
-wpextract path_to_json/ path_to_scrape/ path_to_out/ --json-prefix 202212-09-exampleorg-
-```
+Available under the Apache 2.0 license. See [LICENSE](LICENSE) for more information.
 
-This prefix will also be added to the output files.
+## Citing
 
-### Logging
-
-Basic progress logging and tqdm progress bars are shown in stdout and stderr respectively.
-
-- To display more logs, including non-critical failures (e.g. unable to extract translations for a page) use the `--verbose`/`-v` argument
-- To write logs to a file instead of stdout, use the `--log LOG_FILE`/`-l LOG_FILE` argument. Progress bars will still be sent to stderr.
-
-## Using as a library
-
-The extractor can also be used as a library instead of on the command line.
-
-Typically, you would instantiate a new [`WPExtractor`](src/extractor/extract.py) instance and call its `extract` method. The dataframes can then be accessed as class attributes or exported with the `export` method.
-
-An example usage is available in the CLI script ([`extractor.cli`](src/extractor/cli/cli.py)).
-
-When using this approach, it's possible to use customised translation pickers (see the `translation_pickers` argument of `WPExtractor`). These should be child classes of [`extractor.parse.translations.LangPicker`](src/extractor/parse/translations/_pickers.py).
-
-## Extraction Overview
-
-This section contains an overview of the extraction process for data.
-
-### 1. Scrape Crawling
-
-Website scraping tools may store a webpage at a path that is not easy to derive from the URL (e.g. because of path length limits). For this reason, we crawl the scrape directory and build a mapping of URL to path.
-
-For every html file at any depth in the scrape directory, we:
-1. Perform a limited parse of only the link and meta tags in the file's head.
-2. Attempt to extract a valid URL from a `link` tag with `rel="alternate"` or `canonical` meta tag
-3. Check the URL has not previously been seen, warn and skip if it has
-4. Add the URL to the map with the absolute path of the file
-
-This map is then saved as `url_cache.json` in the scrape directory. If an existing cache file is detected, it will be used instead of scraping again, unless a breaking change has been made to the file schema.
-
-### 2. Content Extraction
-
-Each type of content (posts, pages, media etc) is now extracted in turn.
-
-The extraction process is applied to all posts simultaneously in the following order:
-1. Extract raw text from the HTML-formatted title and excerpt.
-2. Parse the HTML content from the API response input.
-3. Parse the HTML content from the scrape file, if it was found for the link during the crawl
-4. Extract the post's language and translations from the scrape file
-   * Translations are detected using the translation pickers in the [`extractor.parse.translations`](src/extractor/parse/translations) module.
-   * Custom pickers can be added by [using this tool as a library](#using-as-a-library)
-   * Any extracted translations are stored as unresolved links
-5. Add the post's link to the link registry
-6. Using the parsed API content response, extract:
-   * Internal links (stored as unresolved links)
-   * External links (stored as resolved links)
-   * Embeds (`iframe` tags)
-   * Images (stored as unresolved media if internal, resolved media if external), including their source URL, alt text and caption (if they are in a `figure`)
-   * Raw text content, via the following process:
-     1. Remove tags which contain unwanted text (e.g. `figcaptions`)
-     2. Replace `<br>` tags and `<p>` tags with newline characters
-     3. Combine all page text
-
-Other types are extracted in similar ways. Any additional user-supplied fields with HTML formatting (such as media captions) are also extracted as plain text.
-
-### 4. Translation Normalisation and Link Resolution
-
-Translations are normalised by checking that for every translation relation (e.g. `en` -> `fr`), the reverse exists. If not, it will be added.
-
-
-After all types have been processed, the link registry is used to process the unresolved links, translations and media.
-
-For every resolution, the following steps are performed:
-1. Remove the `preview_id` query parameter from the URL if present
-2. Attempt to look up the URL in the link registry
-3. If unsuccessful, use a heuristic to detect category slugs in the URL and try without them
-   * We do this in case sites have removed category slugs from the permalink at some point.
-4. If unsuccessful, warn that the URL is unresolvable
-
-For each resolved link, translation, or media, a destination is set containing its normalised URL, data type, and ID.
-
-### 5. Export
-
-The columns of each type are subset and exported as a JSON file each.
-
-## Acknowledgements and License
+We'd love to hear about your use of our tool, you can [email us](mailto:frheppell1@sheffield.ac.uk) to let us know! Feel free to create issues and/or pull requests for new features or bugs.
 
-This software is made available under the terms of the [Apache License version 2.0](LICENSE).
+If you use this tool in published work, please cite [our EMNLP paper](https://aclanthology.org/2023.emnlp-main.349/):
 
-Portions of this software are derived from other works, see [the `NOTICE` file](NOTICE) for further information.
\ No newline at end of file
+> Freddy Heppell, Kalina Bontcheva, and Carolina Scarton. 2023. Analysing State-Backed Propaganda Websites: a New Dataset and Linguistic Study. In Proceedings of the 2023 Conference on Empirical Methods in Natural Language Processing, pages 5729–5741, Singapore. Association for Computational Linguistics.
diff --git a/docs/advanced/library.md b/docs/advanced/library.md
new file mode 100644
index 0000000..734d4f3
--- /dev/null
+++ b/docs/advanced/library.md
@@ -0,0 +1,27 @@
+# Using as a Library
+
+The extractor can also be used as a library instead of on the command line.
+
+Typically, you would:
+
+- instantiate a [`WPDownloader`][extractor.WPDownloader] instance and call its [`download`][extractor.WPDownloader.download] method.
+- instantiate a [`WPExtractor`][extractor.WPExtractor] instance and call its `extract` method. The dataframes can then be accessed as class attributes or exported with the `export` method.
+
+Examples of usage are available in the CLI scripts in the `extractor.cli` module.
+
+
+
+## Downloader
+
+Use the [`extractor.WPDownloader`][extractor.WPDownloader] class.
+
+Possible customisations include:
+
+- Implement highly custom request behaviour by subclassing [`RequestSession`][extractor.dl.RequestSession] and passing to the `session` parameter.
+
+
+## Extractor
+
+Use the [`extractor.WPExtractor`][extractor.WPExtractor] class.
+
+When using this approach, it's possible to use [customised translation pickers](../advanced/multilingual.md#adding-support) by passing subclasses of [`LanguagePicker`][extractor.parse.translations.LangPicker] to the 
diff --git a/docs/advanced/multilingual.md b/docs/advanced/multilingual.md
new file mode 100644
index 0000000..b29a209
--- /dev/null
+++ b/docs/advanced/multilingual.md
@@ -0,0 +1,122 @@
+# Multilingual Sites
+
+If sites publish in multiple languages and use a plugin to present a list of language versions, wpextract can parse this and add multilingual data in the output dataset.
+
+## Extraction Process
+
+Extracting multilingual data is performed during the [extract command](../usage/extract.md). This data isn't available in the WordPress REST API response, so instead must be obtained from scraped HTML.
+
+Obtaining the scraped HTML is relatively straightforward, as we already have a list of all posts from the [download command](../usage/download.md).
+
+One way this could be scraped is using `jq` to parse the downloaded posts file and produce a URL list, then `wget` to download each page:
+
+```shell-session
+$ cat posts.json | jq -r '.[] | .link' > url_list.txt
+$ touch rejected.log
+$ wget --adjust-extension --input-file=url_list.txt \
+     --wait 1 --random-wait --force-directories \
+     --rejected-log=rejected.log
+```
+
+When running [the extract command](../usage/extract.md), pass this directory as the `--scrape-root` argument. The scrape will be crawled to match URLs to downloaded HTML files following [this process](../usage/extract.md#1-scrape-crawling-optional).
+
+
+## Supported Plugins
+
+wpextract uses an extensible system of parsers to find language picker elements and extract their data.
+
+Currently the following plugins are supported:
+
+### Polylang
+[Plugin Page](https://wordpress.org/plugins/polylang/) &middot; [Website](https://polylang.pro/)
+
+**Supports**:
+
+- Adding as a widget (e.g. to a sidebar)
+
+    ??? example
+        ```html
+        --8<-- "tests/parse/translations/test_pickers/polylang.html:struct"
+        ```
+
+
+- Adding to the navbar as a custom dropdown[^dropdown]
+
+    ??? example
+        ```html
+        --8<-- "tests/parse/translations/test_pickers/generic_polylang.html:struct"
+        ```
+
+**Does not support**:
+
+- Methods which show the picker as a `<select>` element
+
+[^dropdown]: This implementation may be overly customised to the site it was added to collect.
+
+## Adding Support
+
+!!! info "See also"
+    [Using WPextract as a library](library.md) for information on how to run wpextract as a library using additional pickers.
+
+Support can be added by creating a new picker definition inheriting from [`LangPicker`][extractor.parse.translations.LangPicker].
+
+This parent class defines two abstract methods which must be implemented:
+
+- [`LangPicker.get_root`][extractor.parse.translations.LangPicker.get_root] - returns the root element of the picker
+- [`LangPicker.extract`][extractor.parse.translations.LangPicker.extract] - find the languages, call [`LangPicker.set_current_lang`][extractor.parse.translations.LangPicker.set_current_lang] and call [`LangPicker.add_translation`][extractor.parse.translations.LangPicker.add_translation] for each
+
+More complicted pickers may need to override additional methods of the class, but should still ultimately populate the [`LangPicker.translations`][extractor.parse.translations.LangPicker.translations] and [`LangPicker.current_language`][extractor.parse.translations.LangPicker.current_language] attributes as the parent class does.
+
+This section will show implementing a new picker with the following simplified markup:
+
+```html
+<ul class="translations">
+  <li><a href="/page/" class="lang current-lang" lang="en">English</a></li>
+  <li><a href="/de/seite/" class="lang" lang="de">Deutsch</a></li>
+  <li><a href="/page/" class="lang no-translation" lang="fr">Français</a></li>
+</ul>
+```
+The correct parse of this picker should set the current language to English, add German as a translation, and ignore French.
+
+### `get_root()`
+
+Using the `self.page_doc` attribute, a [`BeautifulSoup`][bs4.BeautifulSoup] object representing the page, the root element of the picker should be found and returned.
+
+The `select_one` method is used to find the root element, and will return `None` if no element is found, which will be intepreted as the picker not being present on the page.
+
+If a value is returned, the `self.root_el` attribute will be populated with the result of this method.
+
+??? example "Example `get_root` implementation"
+    ```python
+
+    class MyPicker(LangPicker):
+        ...
+        def get_root(self) -> Tag:
+            return self.page_doc.select_one('ul', class_='translations')
+    ```
+
+### `extract()`
+
+Using the `self.root_el` attribute, the languages should be found and added to the dataset.
+
+Be careful to avoid:
+- Adding the current language
+- Adding languages which are listed but don't have translations
+
+??? example "Example `extract` implementation"
+    ```python
+
+    class MyPicker(LangPicker):
+        ...
+        def extract(self):
+            for lang_el in self.root_el.select('li'):
+                lang_a = lang_el.select_one('a')
+                if 'current-lang' in lang_a.get('class'):
+                    self.set_current_lang(lang)
+                elif 'no-translation' not in lang_a.get('class'):
+                    self.add_translation(lang_a.get('href'), lang_a.get('lang'))
+    ```
+
+### Contributing Pickers
+
+We welcome contributions via a GitHub PR so long as the picker is not overly specific to a single site. 
\ No newline at end of file
diff --git a/docs/api/downloader.md b/docs/api/downloader.md
new file mode 100644
index 0000000..502fc41
--- /dev/null
+++ b/docs/api/downloader.md
@@ -0,0 +1,13 @@
+# Downloader API
+
+## Downloading
+
+::: extractor.WPDownloader
+
+## Configuring Request Behaviour
+
+::: extractor.dl.RequestSession
+    options:
+        members: false
+
+::: extractor.dl.requestsession.AuthorizationType
diff --git a/docs/api/extractor.md b/docs/api/extractor.md
new file mode 100644
index 0000000..59f81fa
--- /dev/null
+++ b/docs/api/extractor.md
@@ -0,0 +1,25 @@
+# Extractor API
+
+## Extraction
+::: extractor.WPExtractor
+
+## Extraction Data
+
+
+::: extractor.extractors.data.links
+    options:
+        show_root_heading: false
+        show_root_toc_entry: false
+
+## Multilingual Extraction
+
+::: extractor.parse.translations.LangPicker
+
+::: extractor.parse.translations.PickerListType
+
+::: extractor.parse.translations.TranslationLink
+    options:
+        inherited_members:
+          - destination
+          - href
+
diff --git a/docs/changelog.md b/docs/changelog.md
new file mode 100644
index 0000000..0a77133
--- /dev/null
+++ b/docs/changelog.md
@@ -0,0 +1,5 @@
+# Changelog
+
+## v1.0.0
+
+- TODO
\ No newline at end of file
diff --git a/docs/img/rrn-data.png b/docs/img/rrn-data.png
new file mode 100644
index 0000000..1768304
Binary files /dev/null and b/docs/img/rrn-data.png differ
diff --git a/docs/index.md b/docs/index.md
new file mode 100644
index 0000000..735c828
--- /dev/null
+++ b/docs/index.md
@@ -0,0 +1,42 @@
+---
+title: Home
+hide:
+  - toc
+---
+
+
+# WPextract - WordPress Site Extractor
+
+**WPextract is a tool to create datasets from WordPress sites.**
+
+- Archives posts, pages, tags, categories, media (including files), comments, and users
+- Uses the WordPress API to guarantee 100% accurate and complete content
+- Resolves internal links and media to IDs
+- Automatically parses multilingual sites to create parallel datasets
+
+## Quickstart
+
+1. Install with `pipx`
+    ```shell-session
+    $ pipx install wpextract
+    ```
+2. Download site data
+    ```shell-session
+    $ wpextract dl "https://example.org" out_dl
+    ```
+3. Process into a dataset
+    ```shell-session
+    $ wpextract extract out_dl out_data
+    ```
+
+## About WPextract
+
+WPextract was built by [Freddy Heppell](https://freddyheppell.com) of the [GATE Project](https://gate.ac.uk) at the [School of Computer Science, University of Sheffield](https://sheffield.ac.uk/cs), originally created to scrape mis/disinformation websites for research.
+
+## Citing WPextract
+
+We'd love to hear about your use of our tool, you can [email us](mailto:frheppell1@sheffield.ac.uk) to let us know! Feel free to create issues and/or pull requests for new features or bugs.
+
+If you use this tool in published work, please cite [our EMNLP paper](https://aclanthology.org/2023.emnlp-main.349/):
+
+> Freddy Heppell, Kalina Bontcheva, and Carolina Scarton. 2023. Analysing State-Backed Propaganda Websites: a New Dataset and Linguistic Study. In Proceedings of the 2023 Conference on Empirical Methods in Natural Language Processing, pages 5729–5741, Singapore. Association for Computational Linguistics.
\ No newline at end of file
diff --git a/docs/intro/install.md b/docs/intro/install.md
new file mode 100644
index 0000000..0d88157
--- /dev/null
+++ b/docs/intro/install.md
@@ -0,0 +1,90 @@
+# Installing
+
+WPextract is available on the PyPI and Anaconda package indexes.
+
+The minimum supported Python version is 3.9. WPextract should work on any Python-supported operating system.
+
+## With `pipx` (recommended for end-users)
+
+[pipx](https://pipx.pypa.io/stable/) will automatically install WPextract and its dependencies in an isolated yet globally-accessible environment.
+
+We recommend this method for those wishing to use WPextract through its command line interface.
+
+1. If pipx is not already installed, follow the steps in the [pipx installation instructions](https://pipx.pypa.io/stable/installation/)
+2. Install WPextract:
+    ```shell-session
+    $ pipx install wpextract
+    ```
+3. Test installation:
+    ```shell-session
+    $ wpextract --help
+    ```
+
+??? info "Upgrading"
+
+    To upgrade versions use:
+    ```shell-session
+    $ pipx upgrade wpextract
+    ```
+??? info "Multiple/Specific Versions"
+    To install a specific version, use:
+    ```shell-session
+    $ pipx install wpextract==1.0.0
+    ```
+    Multiple versions can be installed in parallel using suffixes:
+    ```shell-session
+    $ pipx install --suffix=@1.0.0 wpextract==1.0.0
+    $ pipx install --suffix=@1.1.0 wpextract==1.1.0
+    $ wpextract@1.0.0 --version
+    $ wpextract@1.1.0 --version
+    ```
+    The suffix is user-specified and does not necessarily have to match the version number.
+
+??? info "Uninstalling"
+    To uninstall, use:
+    ```shell-session
+    $ pipx uninstall wpextract
+    ```
+    This will cleanly uninstall the package and delete its environment
+
+
+## With `pip` or `conda`
+
+To install within an existing environment, which is necessary to use WPextract as a library.
+
+WPextract can be manually installed with:
+
+=== "Pip"
+    ```shell-session
+    $ pip install wpextract
+    ```
+=== "Conda"
+    ```shell-session
+    $ conda install wpextract
+    ```
+
+The installation can be tested through the command-line interface:
+
+```shell-session
+$ wpextract --help
+```
+
+or through importing as a library:
+
+```pycon
+>>> import wpextract
+>>> wpextract.__version__
+1.0.0
+```
+
+## For Development
+
+Dependencies for development and packaging are managed through [Poetry](https://python-poetry.org/).
+
+Poetry will automatically install dependencies and the package itself in editable mode:
+
+ ```shell-session
+ $ poetry install
+ $ poetry install --with docs # to build docs locally
+ $ wpextract --help
+ ```
diff --git a/docs/intro/start.md b/docs/intro/start.md
new file mode 100644
index 0000000..fedfa6c
--- /dev/null
+++ b/docs/intro/start.md
@@ -0,0 +1,78 @@
+# Getting Started
+
+In this guide we will use the command-line interface (CLI) of WPextract to download a copy of a WordPress site and produce a usable cross-referenced dataset. Afterwards, you should be ready to use WPextract for your own research or archiving.
+
+!!! warning "Be considerate when using this tool."
+
+    It is your responsibility to ensure any usage of this tool is ethical and compliant with the law. In general, you should only scrape sites with permission of the owner, or for appropriate research following your institution's ethical guidelines.
+    
+    You should use the options included in the `dl` command to minimise the impact of this tool on servers.
+
+
+## Installation
+
+See the [installation instructions](install.md) for requirements and alternative methods.
+
+
+WPExtract can be quickly installed in a sandboxed environment with [pipx](https://pipx.pypa.io/stable/docs/):
+
+```shell-session
+$ pipx install wpextract
+```
+
+## WPextract Stages
+
+WPextract works in two steps:
+
+1. The **downloader** uses the WordPress REST API to obtain all content on the site, which is stored as a single, long file
+2. The **extractor** converts this into a usable dataset by enriching the downloaded content. This includes extracting text, images, resolving links to posts/pages, and finding translated versions[^lang]
+
+[^lang]: {-} See the specific guide for more on multilingual extraction.
+
+We call these two stages using two CLI commands ([`wpextract dl`](../usage/download.md#command-usage) and [`wpextract extract`](../usage/extract.md#command-usage)). Alternatively, WPExtract can be integrated into a project by [using it as a library](../advanced/library.md).
+
+## 1. Downloading
+
+For the purposes of this guide, we'll use the URL `https://example.org` - in reality this isn't a WordPress site, so you should replace it with the URL of the site you're interested in.
+
+To download the contents of `https://example.org` to the directory `./example.org`, run:
+
+```shell-session
+$ wpextract dl "https://example.org" ./example.org
+```
+
+Progress bars will be displayed as it iterates through the pages of each content type until completed.
+
+The `./example.org` directory will now contain 6 JSON files containing the categories, media, pages, posts, tags and users data. These are simply all the pages retrieved from the API, concatenated together.
+
+Using this data directly has several issues:
+
+- _Post and page content is provided as rendered HTML_ - although this is cleaner than scraped HTML, it may still contain intermingled content like images.
+- _No information on links or media_ - links between posts and pages and media used are only available as `<a>`/`<img>` tags within the source, so can't be directly used for analysis
+- _Data may be missing_ - Data from some plugins may not be present in the API response, so an HTML scrape needs to be performed and somehow connected to the API response.
+
+To rectify this, we use the extract command to build a usable dataset.
+
+## 2. Extraction
+
+Now, we call the second command passing in the output directory from the first (`./example.org`) and an output directory for our data (`./example.org-data`)
+
+```shell-session
+$ wpextract extract ./example.org ./example.org-data
+```
+
+This will again output 6 JSON files containing a modified version of the WordPress API schema. This includes:
+
+- plain text content for posts and pages with normalised paragraph breaks and no stray inline content
+- internal links are resolved to the type of data (post, page, media) and its ID
+- media is resolved to its associated media ID
+- embeds (`<iframe>` tags, e.g. YouTube videos) are listed
+- many unnecessary fields are removed
+- some fields provided by plugins are kept and used if available
+
+## Further Information
+
+This guide only covered the basic use-case of WPextract, for further information see:
+
+* More comprehensive documentation of the [download](../usage/download.md) and [extract](../usage/extract.md) commands
+* How to extract [multilingual data](../advanced/multilingual.md)
\ No newline at end of file
diff --git a/docs/intro/why.md b/docs/intro/why.md
new file mode 100644
index 0000000..6a2cf7c
--- /dev/null
+++ b/docs/intro/why.md
@@ -0,0 +1,38 @@
+# Why WPextract?
+
+Scraping websites for research is a common practice in the Natural Language Processing, Computational Social Science, and Digital Humanities fields.
+
+A typical scraping operation might be performed recursively using a tool such as [`wget`](https://www.gnu.org/software/wget/manual/html_node/Recursive-Retrieval-Options.html) or [HTTrack](https://www.httrack.com/), where the homepage of the site is visited, then all pages linked on the homepage, then all pages linked on those pages, and so on to a maximum depth. Each page's HTML is downloaded and stored in a structure resembling its URL.
+
+This approach presents several issues:
+
+- **Only pages reachable within a certain depth will be saved** - this can be particularly problematic for blogs where older articles require navigation through several pages of archives to access.
+- **The downloaded HTML must then be parsed to extract the desired content** - this can be complex and tiresome, and may require different implementations for different websites
+- **Only metadata exposed on the page is collected** - or if the site is operated by a bad actor (such as in disinformation study), the metadata shown on the page may be false
+
+Some other approaches partially resolve these issues, like using a sitemap to obtain a list of all webpages, but this is still imperfect.
+
+## WordPress
+
+WordPress is a popular open-source content management system (CMS). It is widely popular due to the availability of cheap hosting, expertise, and a wide range of themes and plugins. Therefore, inevitably, it is a popular tool for bad actors.
+
+WordPress exposes a [REST API](https://developer.wordpress.org/rest-api/), which can be used to list the posts, pages, and other content types of the site. Using this API instead of an HTML scrape:
+
+- **All content can be obtained**, even content which isn't linked to anywhere
+- **Clean content is provided** exactly as was entered into the editor box
+- **Additional metadata is available**, including precise timestamps, incremental IDs, exact authorship data, and more.
+
+## Limitations
+
+- **Only WordPress sites are supported** - this is an inherent limitation of using the WordPress API
+- **Some security/performance plugins may block the API**
+- **Certain types of data are not present in the API** - e.g. [multilingual data](../advanced/multilingual.md), some comment plugins.
+- **Custom data types will not be extracted** - the tool specifically works on the standard WordPress data types. Even if a plugin exposes a new data type in the same way, it will not be extracted.
+
+## Use in Research
+
+WPextract was built initially to study two state-backed propaganda sites, subsequently published in the paper [Analysing State-Backed Propaganda Websites: a New Dataset and Linguistic Study](https://aclanthology.org/2023.emnlp-main.349/) at EMNLP 2023.
+
+In this example, a disinformation article is shown. On the left, various potential parts of interest are highlighted, which would require relatively complex parsing written specifically for this site. On the right, the data extracted by WPextract via the API is shown. This includes data not present on the page (modification time) or obscured by the site owners (author).
+
+[![](../img/rrn-data.png)](../img/rrn-data.png)
\ No newline at end of file
diff --git a/docs/license.md b/docs/license.md
new file mode 100644
index 0000000..dc69c1a
--- /dev/null
+++ b/docs/license.md
@@ -0,0 +1,26 @@
+# License and Acknowledgements
+
+Copyright 2022-24 The University of Sheffield
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0).
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+Portions of this code are derived from [WPJsonScraper](https://github.com/MickaelWalter/wp-json-scraper), which is available under the MIT license. For details, see [src/extractor/dl/ORIGINAL_LICENSE](https://github.com/GateNLP/wordpress-site-extractor/blob/main/src/extractor/dl/ORIGINAL_LICENSE).
+
+## Acknowledgements
+
+Development of this project was jointly supported by:
+
+- InnovateUK grant number 10039039 (approved under the Horizon Europe Programme as [VIGILANT](https://www.vigilantproject.eu/), EU grant agreement number 101073921.
+- InnovateUK grant number 10039055 (approved under the Horizon Europe Programme as [vera.ai](https://www.veraai.eu/home), EU grant agreement number 101070093).
+- Transnational Access funds from "[SoBigData++](http://sobigdata.eu): European Integrated Infrastructure for Social Mining and BigData Analytics" (Horizon 2020 grant agreement number 871042).
+- A [University of Sheffield Faculty of Engineering](https://sheffield.ac.uk/engineering) PGR Prize Scholarship
+
+Parts of this program are derived from [WPJsonScraper](https://github.com/MickaelWalter/wp-json-scraper) by Mickael Walter.
\ No newline at end of file
diff --git a/docs/styles/custom.css b/docs/styles/custom.css
new file mode 100644
index 0000000..b17350d
--- /dev/null
+++ b/docs/styles/custom.css
@@ -0,0 +1,35 @@
+.language-shell-session .gp, .language-shell-session .go {
+  user-select: none;
+}
+
+.language-pycon .gp, .language-pycon .go {
+  user-select: none;
+}
+
+/* Indentation. */
+div.doc-contents:not(.first) {
+  padding-left: 25px;
+  border-left: .05rem solid var(--md-typeset-table-color);
+}
+
+/* Mark external links as such. */
+a.external::after,
+a.autorefs-external::after {
+  /* https://primer.style/octicons/arrow-up-right-24 */
+  mask-image: url('data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18.25 15.5a.75.75 0 00.75-.75v-9a.75.75 0 00-.75-.75h-9a.75.75 0 000 1.5h7.19L6.22 16.72a.75.75 0 101.06 1.06L17.5 7.56v7.19c0 .414.336.75.75.75z"></path></svg>');
+  -webkit-mask-image: url('data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18.25 15.5a.75.75 0 00.75-.75v-9a.75.75 0 00-.75-.75h-9a.75.75 0 000 1.5h7.19L6.22 16.72a.75.75 0 101.06 1.06L17.5 7.56v7.19c0 .414.336.75.75.75z"></path></svg>');
+  content: ' ';
+
+  display: inline-block;
+  vertical-align: middle;
+  position: relative;
+
+  height: 1em;
+  width: 1em;
+  background-color: currentColor;
+}
+
+a.external:hover::after,
+a.autorefs-external:hover::after {
+  background-color: var(--md-accent-fg-color);
+}
\ No newline at end of file
diff --git a/docs/usage/download.md b/docs/usage/download.md
new file mode 100644
index 0000000..5ebc676
--- /dev/null
+++ b/docs/usage/download.md
@@ -0,0 +1,109 @@
+# Download Command
+
+The `wpextract dl` command downloads the content of a site using the REST API.
+
+## Command Usage
+
+```shell-session
+$ wpextract dl target out_json
+```
+
+`target`
+: The HTTP(S) URL of the WordPress site.
+
+`out_json`
+: Directory to output to
+
+**skip data**
+
+`--no-categories` `--no-media` `--no-pages` `--no-posts` `--no-tags` `--no-users`
+: Skip downloading the given data type
+
+**authentication**
+
+`--auth AUTH`
+: Define HTTP Basic credentials in format username:password
+
+`--cookies COOKIES`
+: Define cookies to send with request in the format "cookie1=foo; cookie2=bar"
+
+`--proxy PROXY`
+: Define a proxy server to use
+
+**request behaviour**
+
+`--timeout TIMEOUT`
+: Stop waiting for a response after a given number of seconds (default: 30)
+
+`--wait WAIT`
+: Wait the specified number of seconds between retrievals (default: None)
+
+`--random-wait`
+: Randomly varies the time between requests to between 0.5 and 1.5 times the number of seconds set by –wait
+
+`--max-retries MAX_RETRIES`
+: Maximum number of retries before giving up (default: 10)
+
+`--backoff-factor BACKOFF_FACTOR`
+: Factor to apply delaying retries. Default will sleep for 0.0, 0.2, 0.4, 0.8,… (default: 0.1)
+
+`--max-redirects MAX_REDIRECTS`
+: Maximum number of redirects before giving up (default: 20)
+
+**logging**
+
+`--log LOG`, `-l LOG`
+: Log outputs to this file instead of stdout.
+
+`--verbose`, `-v`
+: Show additional debug logs
+
+## Download Process
+
+For each enabled data type (categories, media, pages, posts, tags, users; all by default), the command will use the REST API to download the data. The API is paginated and the command will show a progress bar for each page of data.
+
+## Endpoints
+
+To produce each file, the following list endpoints are used:
+
+| File Name         | Endpoint                               |
+|-------------------|----------------------------------------|
+| `categories.json` | [`/wp/v2/categories`][categories_path] |
+| `comments.json`   | [`/wp/v2/comments`][comments_path]     |
+| `media.json`      | [`/wp/v2/media`][media_path]           |
+| `pages.json`      | [`/wp/v2/pages`][pages_path]           |
+| `posts.json`      | [`/wp/v2/posts`][posts_path]           |
+| `tags.json`       | [`/wp/v2/tags`][tags_path]             |
+| `users.json`      | [`/wp/v2/users`][users_path]           |
+
+[categories_path]: https://developer.wordpress.org/rest-api/reference/categories/#list-categories
+[comments_path]: https://developer.wordpress.org/rest-api/reference/comments/#list-comments
+[media_path]: https://developer.wordpress.org/rest-api/reference/media/#list-media
+[pages_path]: https://developer.wordpress.org/rest-api/reference/pages/#list-pages
+[posts_path]: https://developer.wordpress.org/rest-api/reference/posts/#list-posts
+[tags_path]: https://developer.wordpress.org/rest-api/reference/tags/#list-tags
+[users_path]: https://developer.wordpress.org/rest-api/reference/users/#list-users
+
+### Bot Protection and Considerate Scraping
+
+It's unlikely this will trigger bot protection mechanisms for the following reasons:
+
+- it is accessing intended API endpoints, which are likely to have lower levels of bot protection
+- it has been configured to use a browser user agent
+
+The following measures are taken to be considerate to the server:
+
+- a backoff factor is applied to retries
+
+We would also suggest enabling the following options, with consideration for how they will affect the download speed:
+
+- `--wait` to space out requests
+- `--random-wait` to vary the time between requests to avoid patterns
+
+### Error Handling
+
+If an HTTP error occurs, the command will retry the request up to `--max-retries` times, with the backoff set by `--backoff-factor`. If the maximum number of retries is reached, the command will output the error, stop collecting the given data type, and start collecting the following data type. This is because it's presumed that if a given page is non-functional, the following one will be too.
+
+To ensure the integrity of the scrape, it is suggested to check the logs for errors afterwards.
+
+There is currently no mechanism to resume interrupted downloads.
\ No newline at end of file
diff --git a/docs/usage/extract.md b/docs/usage/extract.md
new file mode 100644
index 0000000..a46bcb4
--- /dev/null
+++ b/docs/usage/extract.md
@@ -0,0 +1,97 @@
+# Extract Command
+
+The `wpextract extract` command converts the WordPress API response format into a usable dataset for downstream tasks.
+
+## Command Usage
+
+```shell-session
+$ wpextract extract json_root out_dir
+```
+
+`json_root`
+: Path to files generated by the [`wpextract dl`](download.md) command
+
+`out_dir`
+: Output directory for generated dataset. This should be different to `json_root` as it will create files with the same name.
+
+**optional arguments**
+
+`--scrape-root SCRAPE_ROOT`
+: Root directory of an HTML scrape, see [scrape crawling](#1-scrape-crawling-optional).
+
+`--json-prefix JSON_PREFIX`
+: Load and output files with a prefix, e.g. supplying _20240101-example_ will output posts to `out_dir/20240101-example-posts.json`
+
+**logging**
+
+`--log LOG`, `-l LOG`
+: Log outputs to this file instead of stdout.
+
+`--verbose`, `-v`
+: Show additional debug logs
+
+
+
+## Extraction Process
+
+### 1. Scrape Crawling (optional)
+
+If a scrape is provided with the `--scrape-root` argument, it is first crawled to map the correspondance between the HTML files on disk and the post URLs.
+
+Website scraping tools may store a webpage at a path that is not easy to derive from the URL (e.g. because of path length limits). For this reason, we crawl the scrape directory and build a mapping of URL to path.
+
+For every html file at any depth in the scrape directory, we:
+
+1. Perform a limited parse of only the link and meta tags in the file's head.
+2. Attempt to extract a valid URL from a `link` tag with `rel="alternate"` or `canonical` meta tag
+3. Check the URL has not previously been seen, warn and skip if it has
+4. Add the URL to the map with the absolute path of the file
+
+This map is then saved as `url_cache.json` in the scrape directory. If an existing cache file is detected, it will be used instead of scraping again, unless a breaking change has been made to the file schema.
+
+### 2. Content Extraction
+
+Each type of content (posts, pages, media etc) is now extracted in turn.
+
+The extraction process is applied to all posts simultaneously in the following order:
+
+1. Extract raw text from the HTML-formatted title and excerpt.
+2. Parse the HTML content from the API response input.
+3. Parse the HTML content from the scrape file, if it was found for the link during the crawl
+4. Extract the post's language and translations from the scrape file
+   * Translations are detected using the translation pickers (implementing [`LangPicker`][extractor.parse.translations.LangPicker])
+   * Custom pickers can be added if using this tool as a library
+   * Any extracted translations are stored as unresolved links
+5. Add the post's link to the link registry
+6. Using the parsed API content response, extract:
+   * Internal links (stored as unresolved links)
+   * External links (stored as resolved links)
+   * Embeds (`iframe` tags)
+   * Images (stored as unresolved media if internal, resolved media if external), including their source URL, alt text and caption (if they are in a `figure`)
+   * Raw text content, via the following process:
+     1. Remove tags which contain unwanted text (e.g. `figcaptions`)
+     2. Replace `<br>` tags and `<p>` tags with newline characters
+     3. Combine all page text
+
+Other types are extracted in similar ways. Any additional user-supplied fields with HTML formatting (such as media captions) are also extracted as plain text.
+
+### 4. Translation Normalisation and Link Resolution
+
+Translations are normalised by checking that for every translation relation (e.g. `en` -> `fr`), the reverse exists. If not, it will be added.
+
+
+After all types have been processed, the link registry is used to process the unresolved links, translations and media.
+
+For every resolution, the following steps are performed:
+
+1. Remove the `preview_id` query parameter from the URL if present
+2. Attempt to look up the URL in the link registry
+3. If unsuccessful, use a heuristic to detect category slugs in the URL and try without them
+   * We do this in case sites have removed category slugs from the permalink at some point.
+4. If unsuccessful, warn that the URL is unresolvable
+
+For each resolved link, translation, or media, a destination is set containing its normalised URL, data type, and ID.
+
+### 5. Export
+
+The columns of each type are subset and exported as a JSON file each to the specified output path, using a prefix if supplied.
diff --git a/mkdocs.yml b/mkdocs.yml
new file mode 100644
index 0000000..2f2469c
--- /dev/null
+++ b/mkdocs.yml
@@ -0,0 +1,85 @@
+site_name: WPextract
+copyright: Copyright &copy; 2022 - 2024 The University of Sheffield.
+repo_url: https://github.com/GateNLP/wordpress-site-extractor
+edit_uri: edit/main/docs/
+theme:
+  name: material
+  features:
+    - navigation.sections
+    - navigation.footer
+  palette:
+    primary: 'green'
+
+
+nav:
+  - Home: index.md
+  - 'Intro':
+    - 'Why WPextract?': 'intro/why.md'
+    - 'Installing': 'intro/install.md'
+    - 'Getting Started': 'intro/start.md'
+  - 'Usage':
+    - 'Download Command': 'usage/download.md'
+    - 'Extract Command': 'usage/extract.md'
+  - 'Advanced':
+    - 'Multilingual Sites': 'advanced/multilingual.md'
+    - 'Using as a Library': 'advanced/library.md'
+  - 'Reference':
+    - 'API':
+      - 'Downloader': 'api/downloader.md'
+      - 'Extractor': 'api/extractor.md'
+  - 'About':
+    - 'Changelog': 'changelog.md'
+    - 'License & Acknowledgements': 'license.md'
+
+extra_css:
+  - styles/custom.css
+
+markdown_extensions: 
+  - admonition
+  - pymdownx.details
+  - pymdownx.superfences
+  - footnotes
+  - def_list
+  - pymdownx.snippets:
+      dedent_subsections: true
+  - pymdownx.tabbed:
+      alternate_style: true
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+
+plugins:
+  - search
+  - mkdocstrings:
+      default_handler: python
+      handlers:
+        python:
+          paths: [src]
+          import:
+            - https://www.crummy.com/software/BeautifulSoup/bs4/doc/objects.inv
+            - https://docs.python.org/3/objects.inv
+            - https://requests.readthedocs.io/en/latest/objects.inv
+            - https://pandas.pydata.org/docs/objects.inv
+          options: 
+            docstring_options:
+              ignore_init_summary: true
+            docstring_section_style: spacy
+            # filters: ["!^_"]
+            preload_modules: ["extractor"]
+            heading_level: 3
+            inherited_members: true
+            merge_init_into_class: true
+            parameter_headings: true
+            separate_signature: true
+            show_root_heading: true
+            show_root_full_path: true
+            show_signature_annotations: true
+            show_source: false
+            show_symbol_type_heading: true
+            show_symbol_type_toc: true
+            show_submodules: true
+            # show_if_no_docstring: true
+            signature_crossrefs: true
+            summary: true
+            unwrap_annotated: true
diff --git a/poetry.lock b/poetry.lock
index 5331a3c..c04ee5f 100644
--- a/poetry.lock
+++ b/poetry.lock
@@ -1,5 +1,24 @@
 # This file is automatically @generated by Poetry 1.8.3 and should not be changed by hand.
 
+[[package]]
+name = "babel"
+version = "2.15.0"
+description = "Internationalization utilities"
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "Babel-2.15.0-py3-none-any.whl", hash = "sha256:08706bdad8d0a3413266ab61bd6c34d0c28d6e1e7badf40a2cebe67644e2e1fb"},
+    {file = "babel-2.15.0.tar.gz", hash = "sha256:8daf0e265d05768bc6c7a314cf1321e9a123afc328cc635c18622a2f30a04413"},
+]
+
+[package.extras]
+dev = ["freezegun (>=1.0,<2.0)", "pytest (>=6.0)", "pytest-cov"]
+
+[package.source]
+type = "legacy"
+url = "https://pypi.org/simple"
+reference = "pypi-public"
+
 [[package]]
 name = "beautifulsoup4"
 version = "4.12.3"
@@ -26,6 +45,57 @@ type = "legacy"
 url = "https://pypi.org/simple"
 reference = "pypi-public"
 
+[[package]]
+name = "black"
+version = "24.4.2"
+description = "The uncompromising code formatter."
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "black-24.4.2-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:dd1b5a14e417189db4c7b64a6540f31730713d173f0b63e55fabd52d61d8fdce"},
+    {file = "black-24.4.2-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:8e537d281831ad0e71007dcdcbe50a71470b978c453fa41ce77186bbe0ed6021"},
+    {file = "black-24.4.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:eaea3008c281f1038edb473c1aa8ed8143a5535ff18f978a318f10302b254063"},
+    {file = "black-24.4.2-cp310-cp310-win_amd64.whl", hash = "sha256:7768a0dbf16a39aa5e9a3ded568bb545c8c2727396d063bbaf847df05b08cd96"},
+    {file = "black-24.4.2-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:257d724c2c9b1660f353b36c802ccece186a30accc7742c176d29c146df6e474"},
+    {file = "black-24.4.2-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:bdde6f877a18f24844e381d45e9947a49e97933573ac9d4345399be37621e26c"},
+    {file = "black-24.4.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e151054aa00bad1f4e1f04919542885f89f5f7d086b8a59e5000e6c616896ffb"},
+    {file = "black-24.4.2-cp311-cp311-win_amd64.whl", hash = "sha256:7e122b1c4fb252fd85df3ca93578732b4749d9be076593076ef4d07a0233c3e1"},
+    {file = "black-24.4.2-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:accf49e151c8ed2c0cdc528691838afd217c50412534e876a19270fea1e28e2d"},
+    {file = "black-24.4.2-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:88c57dc656038f1ab9f92b3eb5335ee9b021412feaa46330d5eba4e51fe49b04"},
+    {file = "black-24.4.2-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:be8bef99eb46d5021bf053114442914baeb3649a89dc5f3a555c88737e5e98fc"},
+    {file = "black-24.4.2-cp312-cp312-win_amd64.whl", hash = "sha256:415e686e87dbbe6f4cd5ef0fbf764af7b89f9057b97c908742b6008cc554b9c0"},
+    {file = "black-24.4.2-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:bf10f7310db693bb62692609b397e8d67257c55f949abde4c67f9cc574492cc7"},
+    {file = "black-24.4.2-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:98e123f1d5cfd42f886624d84464f7756f60ff6eab89ae845210631714f6db94"},
+    {file = "black-24.4.2-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:48a85f2cb5e6799a9ef05347b476cce6c182d6c71ee36925a6c194d074336ef8"},
+    {file = "black-24.4.2-cp38-cp38-win_amd64.whl", hash = "sha256:b1530ae42e9d6d5b670a34db49a94115a64596bc77710b1d05e9801e62ca0a7c"},
+    {file = "black-24.4.2-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:37aae07b029fa0174d39daf02748b379399b909652a806e5708199bd93899da1"},
+    {file = "black-24.4.2-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:da33a1a5e49c4122ccdfd56cd021ff1ebc4a1ec4e2d01594fef9b6f267a9e741"},
+    {file = "black-24.4.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ef703f83fc32e131e9bcc0a5094cfe85599e7109f896fe8bc96cc402f3eb4b6e"},
+    {file = "black-24.4.2-cp39-cp39-win_amd64.whl", hash = "sha256:b9176b9832e84308818a99a561e90aa479e73c523b3f77afd07913380ae2eab7"},
+    {file = "black-24.4.2-py3-none-any.whl", hash = "sha256:d36ed1124bb81b32f8614555b34cc4259c3fbc7eec17870e8ff8ded335b58d8c"},
+    {file = "black-24.4.2.tar.gz", hash = "sha256:c872b53057f000085da66a19c55d68f6f8ddcac2642392ad3a355878406fbd4d"},
+]
+
+[package.dependencies]
+click = ">=8.0.0"
+mypy-extensions = ">=0.4.3"
+packaging = ">=22.0"
+pathspec = ">=0.9.0"
+platformdirs = ">=2"
+tomli = {version = ">=1.1.0", markers = "python_version < \"3.11\""}
+typing-extensions = {version = ">=4.0.1", markers = "python_version < \"3.11\""}
+
+[package.extras]
+colorama = ["colorama (>=0.4.3)"]
+d = ["aiohttp (>=3.7.4)", "aiohttp (>=3.7.4,!=3.9.0)"]
+jupyter = ["ipython (>=7.8.0)", "tokenize-rt (>=3.2.0)"]
+uvloop = ["uvloop (>=0.15.2)"]
+
+[package.source]
+type = "legacy"
+url = "https://pypi.org/simple"
+reference = "pypi-public"
+
 [[package]]
 name = "build"
 version = "0.9.0"
@@ -56,13 +126,13 @@ reference = "pypi-public"
 
 [[package]]
 name = "certifi"
-version = "2024.6.2"
+version = "2024.7.4"
 description = "Python package for providing Mozilla's CA Bundle."
 optional = false
 python-versions = ">=3.6"
 files = [
-    {file = "certifi-2024.6.2-py3-none-any.whl", hash = "sha256:ddc6c8ce995e6987e7faf5e3f1b02b302836a0e5d98ece18392cb1a36c72ad56"},
-    {file = "certifi-2024.6.2.tar.gz", hash = "sha256:3cd43f1c6fa7dedc5899d69d3ad0398fd018ad1a17fba83ddaf78aa46c747516"},
+    {file = "certifi-2024.7.4-py3-none-any.whl", hash = "sha256:c198e21b1289c2ab85ee4e67bb4b4ef3ead0892059901a8d5b622f24a1101e90"},
+    {file = "certifi-2024.7.4.tar.gz", hash = "sha256:5a1e7645bc0ec61a09e26c36f6106dd4cf40c6db3a1fb6352b0244e7fb057c7b"},
 ]
 
 [package.source]
@@ -174,6 +244,25 @@ type = "legacy"
 url = "https://pypi.org/simple"
 reference = "pypi-public"
 
+[[package]]
+name = "click"
+version = "8.1.7"
+description = "Composable command line interface toolkit"
+optional = false
+python-versions = ">=3.7"
+files = [
+    {file = "click-8.1.7-py3-none-any.whl", hash = "sha256:ae74fb96c20a0277a1d615f1e4d73c8414f5a98db8b799a7931d1582f3390c28"},
+    {file = "click-8.1.7.tar.gz", hash = "sha256:ca9853ad459e787e2192211578cc907e7594e294c7ccc834310722b41b9ca6de"},
+]
+
+[package.dependencies]
+colorama = {version = "*", markers = "platform_system == \"Windows\""}
+
+[package.source]
+type = "legacy"
+url = "https://pypi.org/simple"
+reference = "pypi-public"
+
 [[package]]
 name = "colorama"
 version = "0.4.6"
@@ -232,6 +321,47 @@ type = "legacy"
 url = "https://pypi.org/simple"
 reference = "pypi-public"
 
+[[package]]
+name = "ghp-import"
+version = "2.1.0"
+description = "Copy your docs directly to the gh-pages branch."
+optional = false
+python-versions = "*"
+files = [
+    {file = "ghp-import-2.1.0.tar.gz", hash = "sha256:9c535c4c61193c2df8871222567d7fd7e5014d835f97dc7b7439069e2413d343"},
+    {file = "ghp_import-2.1.0-py3-none-any.whl", hash = "sha256:8337dd7b50877f163d4c0289bc1f1c7f127550241988d568c1db512c4324a619"},
+]
+
+[package.dependencies]
+python-dateutil = ">=2.8.1"
+
+[package.extras]
+dev = ["flake8", "markdown", "twine", "wheel"]
+
+[package.source]
+type = "legacy"
+url = "https://pypi.org/simple"
+reference = "pypi-public"
+
+[[package]]
+name = "griffe"
+version = "0.47.0"
+description = "Signatures for entire Python programs. Extract the structure, the frame, the skeleton of your project, to generate API documentation or find breaking changes in your API."
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "griffe-0.47.0-py3-none-any.whl", hash = "sha256:07a2fd6a8c3d21d0bbb0decf701d62042ccc8a576645c7f8799fe1f10de2b2de"},
+    {file = "griffe-0.47.0.tar.gz", hash = "sha256:95119a440a3c932b13293538bdbc405bee4c36428547553dc6b327e7e7d35e5a"},
+]
+
+[package.dependencies]
+colorama = ">=0.4"
+
+[package.source]
+type = "legacy"
+url = "https://pypi.org/simple"
+reference = "pypi-public"
+
 [[package]]
 name = "idna"
 version = "3.7"
@@ -248,6 +378,30 @@ type = "legacy"
 url = "https://pypi.org/simple"
 reference = "pypi-public"
 
+[[package]]
+name = "importlib-metadata"
+version = "8.0.0"
+description = "Read metadata from Python packages"
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "importlib_metadata-8.0.0-py3-none-any.whl", hash = "sha256:15584cf2b1bf449d98ff8a6ff1abef57bf20f3ac6454f431736cd3e660921b2f"},
+    {file = "importlib_metadata-8.0.0.tar.gz", hash = "sha256:188bd24e4c346d3f0a933f275c2fec67050326a856b9a359881d7c2a697e8812"},
+]
+
+[package.dependencies]
+zipp = ">=0.5"
+
+[package.extras]
+doc = ["furo", "jaraco.packaging (>=9.3)", "jaraco.tidelift (>=1.4)", "rst.linker (>=1.9)", "sphinx (>=3.5)", "sphinx-lint"]
+perf = ["ipython"]
+test = ["flufl.flake8", "importlib-resources (>=1.3)", "jaraco.test (>=5.4)", "packaging", "pyfakefs", "pytest (>=6,!=8.1.*)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=2.2)", "pytest-mypy", "pytest-perf (>=0.9.2)", "pytest-ruff (>=0.2.1)"]
+
+[package.source]
+type = "legacy"
+url = "https://pypi.org/simple"
+reference = "pypi-public"
+
 [[package]]
 name = "iniconfig"
 version = "2.0.0"
@@ -264,6 +418,28 @@ type = "legacy"
 url = "https://pypi.org/simple"
 reference = "pypi-public"
 
+[[package]]
+name = "jinja2"
+version = "3.1.4"
+description = "A very fast and expressive template engine."
+optional = false
+python-versions = ">=3.7"
+files = [
+    {file = "jinja2-3.1.4-py3-none-any.whl", hash = "sha256:bc5dd2abb727a5319567b7a813e6a2e7318c39f4f487cfe6c89c6f9c7d25197d"},
+    {file = "jinja2-3.1.4.tar.gz", hash = "sha256:4a3aee7acbbe7303aede8e9648d13b8bf88a429282aa6122a993f0ac800cb369"},
+]
+
+[package.dependencies]
+MarkupSafe = ">=2.0"
+
+[package.extras]
+i18n = ["Babel (>=2.7)"]
+
+[package.source]
+type = "legacy"
+url = "https://pypi.org/simple"
+reference = "pypi-public"
+
 [[package]]
 name = "langcodes"
 version = "3.4.0"
@@ -581,6 +757,317 @@ type = "legacy"
 url = "https://pypi.org/simple"
 reference = "pypi-public"
 
+[[package]]
+name = "markdown"
+version = "3.6"
+description = "Python implementation of John Gruber's Markdown."
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "Markdown-3.6-py3-none-any.whl", hash = "sha256:48f276f4d8cfb8ce6527c8f79e2ee29708508bf4d40aa410fbc3b4ee832c850f"},
+    {file = "Markdown-3.6.tar.gz", hash = "sha256:ed4f41f6daecbeeb96e576ce414c41d2d876daa9a16cb35fa8ed8c2ddfad0224"},
+]
+
+[package.dependencies]
+importlib-metadata = {version = ">=4.4", markers = "python_version < \"3.10\""}
+
+[package.extras]
+docs = ["mdx-gh-links (>=0.2)", "mkdocs (>=1.5)", "mkdocs-gen-files", "mkdocs-literate-nav", "mkdocs-nature (>=0.6)", "mkdocs-section-index", "mkdocstrings[python]"]
+testing = ["coverage", "pyyaml"]
+
+[package.source]
+type = "legacy"
+url = "https://pypi.org/simple"
+reference = "pypi-public"
+
+[[package]]
+name = "markupsafe"
+version = "2.1.5"
+description = "Safely add untrusted strings to HTML/XML markup."
+optional = false
+python-versions = ">=3.7"
+files = [
+    {file = "MarkupSafe-2.1.5-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:a17a92de5231666cfbe003f0e4b9b3a7ae3afb1ec2845aadc2bacc93ff85febc"},
+    {file = "MarkupSafe-2.1.5-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:72b6be590cc35924b02c78ef34b467da4ba07e4e0f0454a2c5907f473fc50ce5"},
+    {file = "MarkupSafe-2.1.5-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e61659ba32cf2cf1481e575d0462554625196a1f2fc06a1c777d3f48e8865d46"},
+    {file = "MarkupSafe-2.1.5-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:2174c595a0d73a3080ca3257b40096db99799265e1c27cc5a610743acd86d62f"},
+    {file = "MarkupSafe-2.1.5-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ae2ad8ae6ebee9d2d94b17fb62763125f3f374c25618198f40cbb8b525411900"},
+    {file = "MarkupSafe-2.1.5-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:075202fa5b72c86ad32dc7d0b56024ebdbcf2048c0ba09f1cde31bfdd57bcfff"},
+    {file = "MarkupSafe-2.1.5-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:598e3276b64aff0e7b3451b72e94fa3c238d452e7ddcd893c3ab324717456bad"},
+    {file = "MarkupSafe-2.1.5-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:fce659a462a1be54d2ffcacea5e3ba2d74daa74f30f5f143fe0c58636e355fdd"},
+    {file = "MarkupSafe-2.1.5-cp310-cp310-win32.whl", hash = "sha256:d9fad5155d72433c921b782e58892377c44bd6252b5af2f67f16b194987338a4"},
+    {file = "MarkupSafe-2.1.5-cp310-cp310-win_amd64.whl", hash = "sha256:bf50cd79a75d181c9181df03572cdce0fbb75cc353bc350712073108cba98de5"},
+    {file = "MarkupSafe-2.1.5-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:629ddd2ca402ae6dbedfceeba9c46d5f7b2a61d9749597d4307f943ef198fc1f"},
+    {file = "MarkupSafe-2.1.5-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:5b7b716f97b52c5a14bffdf688f971b2d5ef4029127f1ad7a513973cfd818df2"},
+    {file = "MarkupSafe-2.1.5-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6ec585f69cec0aa07d945b20805be741395e28ac1627333b1c5b0105962ffced"},
+    {file = "MarkupSafe-2.1.5-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b91c037585eba9095565a3556f611e3cbfaa42ca1e865f7b8015fe5c7336d5a5"},
+    {file = "MarkupSafe-2.1.5-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:7502934a33b54030eaf1194c21c692a534196063db72176b0c4028e140f8f32c"},
+    {file = "MarkupSafe-2.1.5-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:0e397ac966fdf721b2c528cf028494e86172b4feba51d65f81ffd65c63798f3f"},
+    {file = "MarkupSafe-2.1.5-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:c061bb86a71b42465156a3ee7bd58c8c2ceacdbeb95d05a99893e08b8467359a"},
+    {file = "MarkupSafe-2.1.5-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:3a57fdd7ce31c7ff06cdfbf31dafa96cc533c21e443d57f5b1ecc6cdc668ec7f"},
+    {file = "MarkupSafe-2.1.5-cp311-cp311-win32.whl", hash = "sha256:397081c1a0bfb5124355710fe79478cdbeb39626492b15d399526ae53422b906"},
+    {file = "MarkupSafe-2.1.5-cp311-cp311-win_amd64.whl", hash = "sha256:2b7c57a4dfc4f16f7142221afe5ba4e093e09e728ca65c51f5620c9aaeb9a617"},
+    {file = "MarkupSafe-2.1.5-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:8dec4936e9c3100156f8a2dc89c4b88d5c435175ff03413b443469c7c8c5f4d1"},
+    {file = "MarkupSafe-2.1.5-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:3c6b973f22eb18a789b1460b4b91bf04ae3f0c4234a0a6aa6b0a92f6f7b951d4"},
+    {file = "MarkupSafe-2.1.5-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ac07bad82163452a6884fe8fa0963fb98c2346ba78d779ec06bd7a6262132aee"},
+    {file = "MarkupSafe-2.1.5-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f5dfb42c4604dddc8e4305050aa6deb084540643ed5804d7455b5df8fe16f5e5"},
+    {file = "MarkupSafe-2.1.5-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ea3d8a3d18833cf4304cd2fc9cbb1efe188ca9b5efef2bdac7adc20594a0e46b"},
+    {file = "MarkupSafe-2.1.5-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:d050b3361367a06d752db6ead6e7edeb0009be66bc3bae0ee9d97fb326badc2a"},
+    {file = "MarkupSafe-2.1.5-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:bec0a414d016ac1a18862a519e54b2fd0fc8bbfd6890376898a6c0891dd82e9f"},
+    {file = "MarkupSafe-2.1.5-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:58c98fee265677f63a4385256a6d7683ab1832f3ddd1e66fe948d5880c21a169"},
+    {file = "MarkupSafe-2.1.5-cp312-cp312-win32.whl", hash = "sha256:8590b4ae07a35970728874632fed7bd57b26b0102df2d2b233b6d9d82f6c62ad"},
+    {file = "MarkupSafe-2.1.5-cp312-cp312-win_amd64.whl", hash = "sha256:823b65d8706e32ad2df51ed89496147a42a2a6e01c13cfb6ffb8b1e92bc910bb"},
+    {file = "MarkupSafe-2.1.5-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:c8b29db45f8fe46ad280a7294f5c3ec36dbac9491f2d1c17345be8e69cc5928f"},
+    {file = "MarkupSafe-2.1.5-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ec6a563cff360b50eed26f13adc43e61bc0c04d94b8be985e6fb24b81f6dcfdf"},
+    {file = "MarkupSafe-2.1.5-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a549b9c31bec33820e885335b451286e2969a2d9e24879f83fe904a5ce59d70a"},
+    {file = "MarkupSafe-2.1.5-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4f11aa001c540f62c6166c7726f71f7573b52c68c31f014c25cc7901deea0b52"},
+    {file = "MarkupSafe-2.1.5-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:7b2e5a267c855eea6b4283940daa6e88a285f5f2a67f2220203786dfa59b37e9"},
+    {file = "MarkupSafe-2.1.5-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:2d2d793e36e230fd32babe143b04cec8a8b3eb8a3122d2aceb4a371e6b09b8df"},
+    {file = "MarkupSafe-2.1.5-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:ce409136744f6521e39fd8e2a24c53fa18ad67aa5bc7c2cf83645cce5b5c4e50"},
+    {file = "MarkupSafe-2.1.5-cp37-cp37m-win32.whl", hash = "sha256:4096e9de5c6fdf43fb4f04c26fb114f61ef0bf2e5604b6ee3019d51b69e8c371"},
+    {file = "MarkupSafe-2.1.5-cp37-cp37m-win_amd64.whl", hash = "sha256:4275d846e41ecefa46e2015117a9f491e57a71ddd59bbead77e904dc02b1bed2"},
+    {file = "MarkupSafe-2.1.5-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:656f7526c69fac7f600bd1f400991cc282b417d17539a1b228617081106feb4a"},
+    {file = "MarkupSafe-2.1.5-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:97cafb1f3cbcd3fd2b6fbfb99ae11cdb14deea0736fc2b0952ee177f2b813a46"},
+    {file = "MarkupSafe-2.1.5-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1f3fbcb7ef1f16e48246f704ab79d79da8a46891e2da03f8783a5b6fa41a9532"},
+    {file = "MarkupSafe-2.1.5-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:fa9db3f79de01457b03d4f01b34cf91bc0048eb2c3846ff26f66687c2f6d16ab"},
+    {file = "MarkupSafe-2.1.5-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ffee1f21e5ef0d712f9033568f8344d5da8cc2869dbd08d87c84656e6a2d2f68"},
+    {file = "MarkupSafe-2.1.5-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:5dedb4db619ba5a2787a94d877bc8ffc0566f92a01c0ef214865e54ecc9ee5e0"},
+    {file = "MarkupSafe-2.1.5-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:30b600cf0a7ac9234b2638fbc0fb6158ba5bdcdf46aeb631ead21248b9affbc4"},
+    {file = "MarkupSafe-2.1.5-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:8dd717634f5a044f860435c1d8c16a270ddf0ef8588d4887037c5028b859b0c3"},
+    {file = "MarkupSafe-2.1.5-cp38-cp38-win32.whl", hash = "sha256:daa4ee5a243f0f20d528d939d06670a298dd39b1ad5f8a72a4275124a7819eff"},
+    {file = "MarkupSafe-2.1.5-cp38-cp38-win_amd64.whl", hash = "sha256:619bc166c4f2de5caa5a633b8b7326fbe98e0ccbfacabd87268a2b15ff73a029"},
+    {file = "MarkupSafe-2.1.5-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:7a68b554d356a91cce1236aa7682dc01df0edba8d043fd1ce607c49dd3c1edcf"},
+    {file = "MarkupSafe-2.1.5-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:db0b55e0f3cc0be60c1f19efdde9a637c32740486004f20d1cff53c3c0ece4d2"},
+    {file = "MarkupSafe-2.1.5-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3e53af139f8579a6d5f7b76549125f0d94d7e630761a2111bc431fd820e163b8"},
+    {file = "MarkupSafe-2.1.5-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:17b950fccb810b3293638215058e432159d2b71005c74371d784862b7e4683f3"},
+    {file = "MarkupSafe-2.1.5-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4c31f53cdae6ecfa91a77820e8b151dba54ab528ba65dfd235c80b086d68a465"},
+    {file = "MarkupSafe-2.1.5-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:bff1b4290a66b490a2f4719358c0cdcd9bafb6b8f061e45c7a2460866bf50c2e"},
+    {file = "MarkupSafe-2.1.5-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:bc1667f8b83f48511b94671e0e441401371dfd0f0a795c7daa4a3cd1dde55bea"},
+    {file = "MarkupSafe-2.1.5-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:5049256f536511ee3f7e1b3f87d1d1209d327e818e6ae1365e8653d7e3abb6a6"},
+    {file = "MarkupSafe-2.1.5-cp39-cp39-win32.whl", hash = "sha256:00e046b6dd71aa03a41079792f8473dc494d564611a8f89bbbd7cb93295ebdcf"},
+    {file = "MarkupSafe-2.1.5-cp39-cp39-win_amd64.whl", hash = "sha256:fa173ec60341d6bb97a89f5ea19c85c5643c1e7dedebc22f5181eb73573142c5"},
+    {file = "MarkupSafe-2.1.5.tar.gz", hash = "sha256:d283d37a890ba4c1ae73ffadf8046435c76e7bc2247bbb63c00bd1a709c6544b"},
+]
+
+[package.source]
+type = "legacy"
+url = "https://pypi.org/simple"
+reference = "pypi-public"
+
+[[package]]
+name = "mergedeep"
+version = "1.3.4"
+description = "A deep merge function for 🐍."
+optional = false
+python-versions = ">=3.6"
+files = [
+    {file = "mergedeep-1.3.4-py3-none-any.whl", hash = "sha256:70775750742b25c0d8f36c55aed03d24c3384d17c951b3175d898bd778ef0307"},
+    {file = "mergedeep-1.3.4.tar.gz", hash = "sha256:0096d52e9dad9939c3d975a774666af186eda617e6ca84df4c94dec30004f2a8"},
+]
+
+[package.source]
+type = "legacy"
+url = "https://pypi.org/simple"
+reference = "pypi-public"
+
+[[package]]
+name = "mkdocs"
+version = "1.6.0"
+description = "Project documentation with Markdown."
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "mkdocs-1.6.0-py3-none-any.whl", hash = "sha256:1eb5cb7676b7d89323e62b56235010216319217d4af5ddc543a91beb8d125ea7"},
+    {file = "mkdocs-1.6.0.tar.gz", hash = "sha256:a73f735824ef83a4f3bcb7a231dcab23f5a838f88b7efc54a0eef5fbdbc3c512"},
+]
+
+[package.dependencies]
+click = ">=7.0"
+colorama = {version = ">=0.4", markers = "platform_system == \"Windows\""}
+ghp-import = ">=1.0"
+importlib-metadata = {version = ">=4.4", markers = "python_version < \"3.10\""}
+jinja2 = ">=2.11.1"
+markdown = ">=3.3.6"
+markupsafe = ">=2.0.1"
+mergedeep = ">=1.3.4"
+mkdocs-get-deps = ">=0.2.0"
+packaging = ">=20.5"
+pathspec = ">=0.11.1"
+pyyaml = ">=5.1"
+pyyaml-env-tag = ">=0.1"
+watchdog = ">=2.0"
+
+[package.extras]
+i18n = ["babel (>=2.9.0)"]
+min-versions = ["babel (==2.9.0)", "click (==7.0)", "colorama (==0.4)", "ghp-import (==1.0)", "importlib-metadata (==4.4)", "jinja2 (==2.11.1)", "markdown (==3.3.6)", "markupsafe (==2.0.1)", "mergedeep (==1.3.4)", "mkdocs-get-deps (==0.2.0)", "packaging (==20.5)", "pathspec (==0.11.1)", "pyyaml (==5.1)", "pyyaml-env-tag (==0.1)", "watchdog (==2.0)"]
+
+[package.source]
+type = "legacy"
+url = "https://pypi.org/simple"
+reference = "pypi-public"
+
+[[package]]
+name = "mkdocs-autorefs"
+version = "1.0.1"
+description = "Automatically link across pages in MkDocs."
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "mkdocs_autorefs-1.0.1-py3-none-any.whl", hash = "sha256:aacdfae1ab197780fb7a2dac92ad8a3d8f7ca8049a9cbe56a4218cd52e8da570"},
+    {file = "mkdocs_autorefs-1.0.1.tar.gz", hash = "sha256:f684edf847eced40b570b57846b15f0bf57fb93ac2c510450775dcf16accb971"},
+]
+
+[package.dependencies]
+Markdown = ">=3.3"
+markupsafe = ">=2.0.1"
+mkdocs = ">=1.1"
+
+[package.source]
+type = "legacy"
+url = "https://pypi.org/simple"
+reference = "pypi-public"
+
+[[package]]
+name = "mkdocs-get-deps"
+version = "0.2.0"
+description = "MkDocs extension that lists all dependencies according to a mkdocs.yml file"
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "mkdocs_get_deps-0.2.0-py3-none-any.whl", hash = "sha256:2bf11d0b133e77a0dd036abeeb06dec8775e46efa526dc70667d8863eefc6134"},
+    {file = "mkdocs_get_deps-0.2.0.tar.gz", hash = "sha256:162b3d129c7fad9b19abfdcb9c1458a651628e4b1dea628ac68790fb3061c60c"},
+]
+
+[package.dependencies]
+importlib-metadata = {version = ">=4.3", markers = "python_version < \"3.10\""}
+mergedeep = ">=1.3.4"
+platformdirs = ">=2.2.0"
+pyyaml = ">=5.1"
+
+[package.source]
+type = "legacy"
+url = "https://pypi.org/simple"
+reference = "pypi-public"
+
+[[package]]
+name = "mkdocs-material"
+version = "9.5.28"
+description = "Documentation that simply works"
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "mkdocs_material-9.5.28-py3-none-any.whl", hash = "sha256:ff48b11b2a9f705dd210409ec3b418ab443dd36d96915bcba45a41f10ea27bfd"},
+    {file = "mkdocs_material-9.5.28.tar.gz", hash = "sha256:9cba305283ad1600e3d0a67abe72d7a058b54793b47be39930911a588fe0336b"},
+]
+
+[package.dependencies]
+babel = ">=2.10,<3.0"
+colorama = ">=0.4,<1.0"
+jinja2 = ">=3.0,<4.0"
+markdown = ">=3.2,<4.0"
+mkdocs = ">=1.6,<2.0"
+mkdocs-material-extensions = ">=1.3,<2.0"
+paginate = ">=0.5,<1.0"
+pygments = ">=2.16,<3.0"
+pymdown-extensions = ">=10.2,<11.0"
+regex = ">=2022.4"
+requests = ">=2.26,<3.0"
+
+[package.extras]
+git = ["mkdocs-git-committers-plugin-2 (>=1.1,<2.0)", "mkdocs-git-revision-date-localized-plugin (>=1.2.4,<2.0)"]
+imaging = ["cairosvg (>=2.6,<3.0)", "pillow (>=10.2,<11.0)"]
+recommended = ["mkdocs-minify-plugin (>=0.7,<1.0)", "mkdocs-redirects (>=1.2,<2.0)", "mkdocs-rss-plugin (>=1.6,<2.0)"]
+
+[package.source]
+type = "legacy"
+url = "https://pypi.org/simple"
+reference = "pypi-public"
+
+[[package]]
+name = "mkdocs-material-extensions"
+version = "1.3.1"
+description = "Extension pack for Python Markdown and MkDocs Material."
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "mkdocs_material_extensions-1.3.1-py3-none-any.whl", hash = "sha256:adff8b62700b25cb77b53358dad940f3ef973dd6db797907c49e3c2ef3ab4e31"},
+    {file = "mkdocs_material_extensions-1.3.1.tar.gz", hash = "sha256:10c9511cea88f568257f960358a467d12b970e1f7b2c0e5fb2bb48cab1928443"},
+]
+
+[package.source]
+type = "legacy"
+url = "https://pypi.org/simple"
+reference = "pypi-public"
+
+[[package]]
+name = "mkdocstrings"
+version = "0.25.1"
+description = "Automatic documentation from sources, for MkDocs."
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "mkdocstrings-0.25.1-py3-none-any.whl", hash = "sha256:da01fcc2670ad61888e8fe5b60afe9fee5781017d67431996832d63e887c2e51"},
+    {file = "mkdocstrings-0.25.1.tar.gz", hash = "sha256:c3a2515f31577f311a9ee58d089e4c51fc6046dbd9e9b4c3de4c3194667fe9bf"},
+]
+
+[package.dependencies]
+click = ">=7.0"
+importlib-metadata = {version = ">=4.6", markers = "python_version < \"3.10\""}
+Jinja2 = ">=2.11.1"
+Markdown = ">=3.3"
+MarkupSafe = ">=1.1"
+mkdocs = ">=1.4"
+mkdocs-autorefs = ">=0.3.1"
+platformdirs = ">=2.2.0"
+pymdown-extensions = ">=6.3"
+typing-extensions = {version = ">=4.1", markers = "python_version < \"3.10\""}
+
+[package.extras]
+crystal = ["mkdocstrings-crystal (>=0.3.4)"]
+python = ["mkdocstrings-python (>=0.5.2)"]
+python-legacy = ["mkdocstrings-python-legacy (>=0.2.1)"]
+
+[package.source]
+type = "legacy"
+url = "https://pypi.org/simple"
+reference = "pypi-public"
+
+[[package]]
+name = "mkdocstrings-python"
+version = "1.10.5"
+description = "A Python handler for mkdocstrings."
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "mkdocstrings_python-1.10.5-py3-none-any.whl", hash = "sha256:92e3c588ef1b41151f55281d075de7558dd8092e422cb07a65b18ee2b0863ebb"},
+    {file = "mkdocstrings_python-1.10.5.tar.gz", hash = "sha256:acdc2a98cd9d46c7ece508193a16ca03ccabcb67520352b7449f84b57c162bdf"},
+]
+
+[package.dependencies]
+griffe = ">=0.47"
+mkdocstrings = ">=0.25"
+
+[package.source]
+type = "legacy"
+url = "https://pypi.org/simple"
+reference = "pypi-public"
+
+[[package]]
+name = "mypy-extensions"
+version = "1.0.0"
+description = "Type system extensions for programs checked with the mypy type checker."
+optional = false
+python-versions = ">=3.5"
+files = [
+    {file = "mypy_extensions-1.0.0-py3-none-any.whl", hash = "sha256:4392f6c0eb8a5668a69e23d168ffa70f0be9ccfd32b5cc2d26a34ae5b844552d"},
+    {file = "mypy_extensions-1.0.0.tar.gz", hash = "sha256:75dbf8955dc00442a438fc4d0666508a9a97b6bd41aa2f0ffe9d2f2725af0782"},
+]
+
+[package.source]
+type = "legacy"
+url = "https://pypi.org/simple"
+reference = "pypi-public"
+
 [[package]]
 name = "numpy"
 version = "2.0.0"
@@ -656,6 +1143,21 @@ type = "legacy"
 url = "https://pypi.org/simple"
 reference = "pypi-public"
 
+[[package]]
+name = "paginate"
+version = "0.5.6"
+description = "Divides large result sets into pages for easier browsing"
+optional = false
+python-versions = "*"
+files = [
+    {file = "paginate-0.5.6.tar.gz", hash = "sha256:5e6007b6a9398177a7e1648d04fdd9f8c9766a1a945bceac82f1929e8c78af2d"},
+]
+
+[package.source]
+type = "legacy"
+url = "https://pypi.org/simple"
+reference = "pypi-public"
+
 [[package]]
 name = "pandas"
 version = "2.2.2"
@@ -734,6 +1236,22 @@ type = "legacy"
 url = "https://pypi.org/simple"
 reference = "pypi-public"
 
+[[package]]
+name = "pathspec"
+version = "0.12.1"
+description = "Utility library for gitignore style pattern matching of file paths."
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "pathspec-0.12.1-py3-none-any.whl", hash = "sha256:a0d503e138a4c123b27490a4f7beda6a01c6f288df0e4a8b79c7eb0dc7b4cc08"},
+    {file = "pathspec-0.12.1.tar.gz", hash = "sha256:a482d51503a1ab33b1c67a6c3813a26953dbdc71c31dacaef9a838c4e29f5712"},
+]
+
+[package.source]
+type = "legacy"
+url = "https://pypi.org/simple"
+reference = "pypi-public"
+
 [[package]]
 name = "pep517"
 version = "0.13.1"
@@ -753,6 +1271,27 @@ type = "legacy"
 url = "https://pypi.org/simple"
 reference = "pypi-public"
 
+[[package]]
+name = "platformdirs"
+version = "4.2.2"
+description = "A small Python package for determining appropriate platform-specific dirs, e.g. a `user data dir`."
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "platformdirs-4.2.2-py3-none-any.whl", hash = "sha256:2d7a1657e36a80ea911db832a8a6ece5ee53d8de21edd5cc5879af6530b1bfee"},
+    {file = "platformdirs-4.2.2.tar.gz", hash = "sha256:38b7b51f512eed9e84a22788b4bce1de17c0adb134d6becb09836e37d8654cd3"},
+]
+
+[package.extras]
+docs = ["furo (>=2023.9.10)", "proselint (>=0.13)", "sphinx (>=7.2.6)", "sphinx-autodoc-typehints (>=1.25.2)"]
+test = ["appdirs (==1.4.4)", "covdefaults (>=2.3)", "pytest (>=7.4.3)", "pytest-cov (>=4.1)", "pytest-mock (>=3.12)"]
+type = ["mypy (>=1.8)"]
+
+[package.source]
+type = "legacy"
+url = "https://pypi.org/simple"
+reference = "pypi-public"
+
 [[package]]
 name = "pluggy"
 version = "1.5.0"
@@ -773,6 +1312,48 @@ type = "legacy"
 url = "https://pypi.org/simple"
 reference = "pypi-public"
 
+[[package]]
+name = "pygments"
+version = "2.18.0"
+description = "Pygments is a syntax highlighting package written in Python."
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "pygments-2.18.0-py3-none-any.whl", hash = "sha256:b8e6aca0523f3ab76fee51799c488e38782ac06eafcf95e7ba832985c8e7b13a"},
+    {file = "pygments-2.18.0.tar.gz", hash = "sha256:786ff802f32e91311bff3889f6e9a86e81505fe99f2735bb6d60ae0c5004f199"},
+]
+
+[package.extras]
+windows-terminal = ["colorama (>=0.4.6)"]
+
+[package.source]
+type = "legacy"
+url = "https://pypi.org/simple"
+reference = "pypi-public"
+
+[[package]]
+name = "pymdown-extensions"
+version = "10.8.1"
+description = "Extension pack for Python Markdown."
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "pymdown_extensions-10.8.1-py3-none-any.whl", hash = "sha256:f938326115884f48c6059c67377c46cf631c733ef3629b6eed1349989d1b30cb"},
+    {file = "pymdown_extensions-10.8.1.tar.gz", hash = "sha256:3ab1db5c9e21728dabf75192d71471f8e50f216627e9a1fa9535ecb0231b9940"},
+]
+
+[package.dependencies]
+markdown = ">=3.6"
+pyyaml = "*"
+
+[package.extras]
+extra = ["pygments (>=2.12)"]
+
+[package.source]
+type = "legacy"
+url = "https://pypi.org/simple"
+reference = "pypi-public"
+
 [[package]]
 name = "pytest"
 version = "8.2.2"
@@ -876,6 +1457,183 @@ type = "legacy"
 url = "https://pypi.org/simple"
 reference = "pypi-public"
 
+[[package]]
+name = "pyyaml"
+version = "6.0.1"
+description = "YAML parser and emitter for Python"
+optional = false
+python-versions = ">=3.6"
+files = [
+    {file = "PyYAML-6.0.1-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:d858aa552c999bc8a8d57426ed01e40bef403cd8ccdd0fc5f6f04a00414cac2a"},
+    {file = "PyYAML-6.0.1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:fd66fc5d0da6d9815ba2cebeb4205f95818ff4b79c3ebe268e75d961704af52f"},
+    {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:69b023b2b4daa7548bcfbd4aa3da05b3a74b772db9e23b982788168117739938"},
+    {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:81e0b275a9ecc9c0c0c07b4b90ba548307583c125f54d5b6946cfee6360c733d"},
+    {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ba336e390cd8e4d1739f42dfe9bb83a3cc2e80f567d8805e11b46f4a943f5515"},
+    {file = "PyYAML-6.0.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:326c013efe8048858a6d312ddd31d56e468118ad4cdeda36c719bf5bb6192290"},
+    {file = "PyYAML-6.0.1-cp310-cp310-win32.whl", hash = "sha256:bd4af7373a854424dabd882decdc5579653d7868b8fb26dc7d0e99f823aa5924"},
+    {file = "PyYAML-6.0.1-cp310-cp310-win_amd64.whl", hash = "sha256:fd1592b3fdf65fff2ad0004b5e363300ef59ced41c2e6b3a99d4089fa8c5435d"},
+    {file = "PyYAML-6.0.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:6965a7bc3cf88e5a1c3bd2e0b5c22f8d677dc88a455344035f03399034eb3007"},
+    {file = "PyYAML-6.0.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:f003ed9ad21d6a4713f0a9b5a7a0a79e08dd0f221aff4525a2be4c346ee60aab"},
+    {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:42f8152b8dbc4fe7d96729ec2b99c7097d656dc1213a3229ca5383f973a5ed6d"},
+    {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:062582fca9fabdd2c8b54a3ef1c978d786e0f6b3a1510e0ac93ef59e0ddae2bc"},
+    {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d2b04aac4d386b172d5b9692e2d2da8de7bfb6c387fa4f801fbf6fb2e6ba4673"},
+    {file = "PyYAML-6.0.1-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:e7d73685e87afe9f3b36c799222440d6cf362062f78be1013661b00c5c6f678b"},
+    {file = "PyYAML-6.0.1-cp311-cp311-win32.whl", hash = "sha256:1635fd110e8d85d55237ab316b5b011de701ea0f29d07611174a1b42f1444741"},
+    {file = "PyYAML-6.0.1-cp311-cp311-win_amd64.whl", hash = "sha256:bf07ee2fef7014951eeb99f56f39c9bb4af143d8aa3c21b1677805985307da34"},
+    {file = "PyYAML-6.0.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:855fb52b0dc35af121542a76b9a84f8d1cd886ea97c84703eaa6d88e37a2ad28"},
+    {file = "PyYAML-6.0.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:40df9b996c2b73138957fe23a16a4f0ba614f4c0efce1e9406a184b6d07fa3a9"},
+    {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a08c6f0fe150303c1c6b71ebcd7213c2858041a7e01975da3a99aed1e7a378ef"},
+    {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6c22bec3fbe2524cde73d7ada88f6566758a8f7227bfbf93a408a9d86bcc12a0"},
+    {file = "PyYAML-6.0.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:8d4e9c88387b0f5c7d5f281e55304de64cf7f9c0021a3525bd3b1c542da3b0e4"},
+    {file = "PyYAML-6.0.1-cp312-cp312-win32.whl", hash = "sha256:d483d2cdf104e7c9fa60c544d92981f12ad66a457afae824d146093b8c294c54"},
+    {file = "PyYAML-6.0.1-cp312-cp312-win_amd64.whl", hash = "sha256:0d3304d8c0adc42be59c5f8a4d9e3d7379e6955ad754aa9d6ab7a398b59dd1df"},
+    {file = "PyYAML-6.0.1-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:50550eb667afee136e9a77d6dc71ae76a44df8b3e51e41b77f6de2932bfe0f47"},
+    {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1fe35611261b29bd1de0070f0b2f47cb6ff71fa6595c077e42bd0c419fa27b98"},
+    {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:704219a11b772aea0d8ecd7058d0082713c3562b4e271b849ad7dc4a5c90c13c"},
+    {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:afd7e57eddb1a54f0f1a974bc4391af8bcce0b444685d936840f125cf046d5bd"},
+    {file = "PyYAML-6.0.1-cp36-cp36m-win32.whl", hash = "sha256:fca0e3a251908a499833aa292323f32437106001d436eca0e6e7833256674585"},
+    {file = "PyYAML-6.0.1-cp36-cp36m-win_amd64.whl", hash = "sha256:f22ac1c3cac4dbc50079e965eba2c1058622631e526bd9afd45fedd49ba781fa"},
+    {file = "PyYAML-6.0.1-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:b1275ad35a5d18c62a7220633c913e1b42d44b46ee12554e5fd39c70a243d6a3"},
+    {file = "PyYAML-6.0.1-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:18aeb1bf9a78867dc38b259769503436b7c72f7a1f1f4c93ff9a17de54319b27"},
+    {file = "PyYAML-6.0.1-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:596106435fa6ad000c2991a98fa58eeb8656ef2325d7e158344fb33864ed87e3"},
+    {file = "PyYAML-6.0.1-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:baa90d3f661d43131ca170712d903e6295d1f7a0f595074f151c0aed377c9b9c"},
+    {file = "PyYAML-6.0.1-cp37-cp37m-win32.whl", hash = "sha256:9046c58c4395dff28dd494285c82ba00b546adfc7ef001486fbf0324bc174fba"},
+    {file = "PyYAML-6.0.1-cp37-cp37m-win_amd64.whl", hash = "sha256:4fb147e7a67ef577a588a0e2c17b6db51dda102c71de36f8549b6816a96e1867"},
+    {file = "PyYAML-6.0.1-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:1d4c7e777c441b20e32f52bd377e0c409713e8bb1386e1099c2415f26e479595"},
+    {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a0cd17c15d3bb3fa06978b4e8958dcdc6e0174ccea823003a106c7d4d7899ac5"},
+    {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:28c119d996beec18c05208a8bd78cbe4007878c6dd15091efb73a30e90539696"},
+    {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7e07cbde391ba96ab58e532ff4803f79c4129397514e1413a7dc761ccd755735"},
+    {file = "PyYAML-6.0.1-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:49a183be227561de579b4a36efbb21b3eab9651dd81b1858589f796549873dd6"},
+    {file = "PyYAML-6.0.1-cp38-cp38-win32.whl", hash = "sha256:184c5108a2aca3c5b3d3bf9395d50893a7ab82a38004c8f61c258d4428e80206"},
+    {file = "PyYAML-6.0.1-cp38-cp38-win_amd64.whl", hash = "sha256:1e2722cc9fbb45d9b87631ac70924c11d3a401b2d7f410cc0e3bbf249f2dca62"},
+    {file = "PyYAML-6.0.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:9eb6caa9a297fc2c2fb8862bc5370d0303ddba53ba97e71f08023b6cd73d16a8"},
+    {file = "PyYAML-6.0.1-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:c8098ddcc2a85b61647b2590f825f3db38891662cfc2fc776415143f599bb859"},
+    {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5773183b6446b2c99bb77e77595dd486303b4faab2b086e7b17bc6bef28865f6"},
+    {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b786eecbdf8499b9ca1d697215862083bd6d2a99965554781d0d8d1ad31e13a0"},
+    {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bc1bf2925a1ecd43da378f4db9e4f799775d6367bdb94671027b73b393a7c42c"},
+    {file = "PyYAML-6.0.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:04ac92ad1925b2cff1db0cfebffb6ffc43457495c9b3c39d3fcae417d7125dc5"},
+    {file = "PyYAML-6.0.1-cp39-cp39-win32.whl", hash = "sha256:faca3bdcf85b2fc05d06ff3fbc1f83e1391b3e724afa3feba7d13eeab355484c"},
+    {file = "PyYAML-6.0.1-cp39-cp39-win_amd64.whl", hash = "sha256:510c9deebc5c0225e8c96813043e62b680ba2f9c50a08d3724c7f28a747d1486"},
+    {file = "PyYAML-6.0.1.tar.gz", hash = "sha256:bfdf460b1736c775f2ba9f6a92bca30bc2095067b8a9d77876d1fad6cc3b4a43"},
+]
+
+[package.source]
+type = "legacy"
+url = "https://pypi.org/simple"
+reference = "pypi-public"
+
+[[package]]
+name = "pyyaml-env-tag"
+version = "0.1"
+description = "A custom YAML tag for referencing environment variables in YAML files. "
+optional = false
+python-versions = ">=3.6"
+files = [
+    {file = "pyyaml_env_tag-0.1-py3-none-any.whl", hash = "sha256:af31106dec8a4d68c60207c1886031cbf839b68aa7abccdb19868200532c2069"},
+    {file = "pyyaml_env_tag-0.1.tar.gz", hash = "sha256:70092675bda14fdec33b31ba77e7543de9ddc88f2e5b99160396572d11525bdb"},
+]
+
+[package.dependencies]
+pyyaml = "*"
+
+[package.source]
+type = "legacy"
+url = "https://pypi.org/simple"
+reference = "pypi-public"
+
+[[package]]
+name = "regex"
+version = "2024.5.15"
+description = "Alternative regular expression module, to replace re."
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "regex-2024.5.15-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:a81e3cfbae20378d75185171587cbf756015ccb14840702944f014e0d93ea09f"},
+    {file = "regex-2024.5.15-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:7b59138b219ffa8979013be7bc85bb60c6f7b7575df3d56dc1e403a438c7a3f6"},
+    {file = "regex-2024.5.15-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:a0bd000c6e266927cb7a1bc39d55be95c4b4f65c5be53e659537537e019232b1"},
+    {file = "regex-2024.5.15-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5eaa7ddaf517aa095fa8da0b5015c44d03da83f5bd49c87961e3c997daed0de7"},
+    {file = "regex-2024.5.15-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:ba68168daedb2c0bab7fd7e00ced5ba90aebf91024dea3c88ad5063c2a562cca"},
+    {file = "regex-2024.5.15-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:6e8d717bca3a6e2064fc3a08df5cbe366369f4b052dcd21b7416e6d71620dca1"},
+    {file = "regex-2024.5.15-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:1337b7dbef9b2f71121cdbf1e97e40de33ff114801263b275aafd75303bd62b5"},
+    {file = "regex-2024.5.15-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:f9ebd0a36102fcad2f03696e8af4ae682793a5d30b46c647eaf280d6cfb32796"},
+    {file = "regex-2024.5.15-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:9efa1a32ad3a3ea112224897cdaeb6aa00381627f567179c0314f7b65d354c62"},
+    {file = "regex-2024.5.15-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:1595f2d10dff3d805e054ebdc41c124753631b6a471b976963c7b28543cf13b0"},
+    {file = "regex-2024.5.15-cp310-cp310-musllinux_1_2_i686.whl", hash = "sha256:b802512f3e1f480f41ab5f2cfc0e2f761f08a1f41092d6718868082fc0d27143"},
+    {file = "regex-2024.5.15-cp310-cp310-musllinux_1_2_ppc64le.whl", hash = "sha256:a0981022dccabca811e8171f913de05720590c915b033b7e601f35ce4ea7019f"},
+    {file = "regex-2024.5.15-cp310-cp310-musllinux_1_2_s390x.whl", hash = "sha256:19068a6a79cf99a19ccefa44610491e9ca02c2be3305c7760d3831d38a467a6f"},
+    {file = "regex-2024.5.15-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:1b5269484f6126eee5e687785e83c6b60aad7663dafe842b34691157e5083e53"},
+    {file = "regex-2024.5.15-cp310-cp310-win32.whl", hash = "sha256:ada150c5adfa8fbcbf321c30c751dc67d2f12f15bd183ffe4ec7cde351d945b3"},
+    {file = "regex-2024.5.15-cp310-cp310-win_amd64.whl", hash = "sha256:ac394ff680fc46b97487941f5e6ae49a9f30ea41c6c6804832063f14b2a5a145"},
+    {file = "regex-2024.5.15-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:f5b1dff3ad008dccf18e652283f5e5339d70bf8ba7c98bf848ac33db10f7bc7a"},
+    {file = "regex-2024.5.15-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:c6a2b494a76983df8e3d3feea9b9ffdd558b247e60b92f877f93a1ff43d26656"},
+    {file = "regex-2024.5.15-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:a32b96f15c8ab2e7d27655969a23895eb799de3665fa94349f3b2fbfd547236f"},
+    {file = "regex-2024.5.15-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:10002e86e6068d9e1c91eae8295ef690f02f913c57db120b58fdd35a6bb1af35"},
+    {file = "regex-2024.5.15-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:ec54d5afa89c19c6dd8541a133be51ee1017a38b412b1321ccb8d6ddbeb4cf7d"},
+    {file = "regex-2024.5.15-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:10e4ce0dca9ae7a66e6089bb29355d4432caed736acae36fef0fdd7879f0b0cb"},
+    {file = "regex-2024.5.15-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:3e507ff1e74373c4d3038195fdd2af30d297b4f0950eeda6f515ae3d84a1770f"},
+    {file = "regex-2024.5.15-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:d1f059a4d795e646e1c37665b9d06062c62d0e8cc3c511fe01315973a6542e40"},
+    {file = "regex-2024.5.15-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:0721931ad5fe0dda45d07f9820b90b2148ccdd8e45bb9e9b42a146cb4f695649"},
+    {file = "regex-2024.5.15-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:833616ddc75ad595dee848ad984d067f2f31be645d603e4d158bba656bbf516c"},
+    {file = "regex-2024.5.15-cp311-cp311-musllinux_1_2_ppc64le.whl", hash = "sha256:287eb7f54fc81546346207c533ad3c2c51a8d61075127d7f6d79aaf96cdee890"},
+    {file = "regex-2024.5.15-cp311-cp311-musllinux_1_2_s390x.whl", hash = "sha256:19dfb1c504781a136a80ecd1fff9f16dddf5bb43cec6871778c8a907a085bb3d"},
+    {file = "regex-2024.5.15-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:119af6e56dce35e8dfb5222573b50c89e5508d94d55713c75126b753f834de68"},
+    {file = "regex-2024.5.15-cp311-cp311-win32.whl", hash = "sha256:1c1c174d6ec38d6c8a7504087358ce9213d4332f6293a94fbf5249992ba54efa"},
+    {file = "regex-2024.5.15-cp311-cp311-win_amd64.whl", hash = "sha256:9e717956dcfd656f5055cc70996ee2cc82ac5149517fc8e1b60261b907740201"},
+    {file = "regex-2024.5.15-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:632b01153e5248c134007209b5c6348a544ce96c46005d8456de1d552455b014"},
+    {file = "regex-2024.5.15-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:e64198f6b856d48192bf921421fdd8ad8eb35e179086e99e99f711957ffedd6e"},
+    {file = "regex-2024.5.15-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:68811ab14087b2f6e0fc0c2bae9ad689ea3584cad6917fc57be6a48bbd012c49"},
+    {file = "regex-2024.5.15-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f8ec0c2fea1e886a19c3bee0cd19d862b3aa75dcdfb42ebe8ed30708df64687a"},
+    {file = "regex-2024.5.15-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:d0c0c0003c10f54a591d220997dd27d953cd9ccc1a7294b40a4be5312be8797b"},
+    {file = "regex-2024.5.15-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:2431b9e263af1953c55abbd3e2efca67ca80a3de8a0437cb58e2421f8184717a"},
+    {file = "regex-2024.5.15-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:4a605586358893b483976cffc1723fb0f83e526e8f14c6e6614e75919d9862cf"},
+    {file = "regex-2024.5.15-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:391d7f7f1e409d192dba8bcd42d3e4cf9e598f3979cdaed6ab11288da88cb9f2"},
+    {file = "regex-2024.5.15-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:9ff11639a8d98969c863d4617595eb5425fd12f7c5ef6621a4b74b71ed8726d5"},
+    {file = "regex-2024.5.15-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:4eee78a04e6c67e8391edd4dad3279828dd66ac4b79570ec998e2155d2e59fd5"},
+    {file = "regex-2024.5.15-cp312-cp312-musllinux_1_2_ppc64le.whl", hash = "sha256:8fe45aa3f4aa57faabbc9cb46a93363edd6197cbc43523daea044e9ff2fea83e"},
+    {file = "regex-2024.5.15-cp312-cp312-musllinux_1_2_s390x.whl", hash = "sha256:d0a3d8d6acf0c78a1fff0e210d224b821081330b8524e3e2bc5a68ef6ab5803d"},
+    {file = "regex-2024.5.15-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:c486b4106066d502495b3025a0a7251bf37ea9540433940a23419461ab9f2a80"},
+    {file = "regex-2024.5.15-cp312-cp312-win32.whl", hash = "sha256:c49e15eac7c149f3670b3e27f1f28a2c1ddeccd3a2812cba953e01be2ab9b5fe"},
+    {file = "regex-2024.5.15-cp312-cp312-win_amd64.whl", hash = "sha256:673b5a6da4557b975c6c90198588181029c60793835ce02f497ea817ff647cb2"},
+    {file = "regex-2024.5.15-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:87e2a9c29e672fc65523fb47a90d429b70ef72b901b4e4b1bd42387caf0d6835"},
+    {file = "regex-2024.5.15-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:c3bea0ba8b73b71b37ac833a7f3fd53825924165da6a924aec78c13032f20850"},
+    {file = "regex-2024.5.15-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:bfc4f82cabe54f1e7f206fd3d30fda143f84a63fe7d64a81558d6e5f2e5aaba9"},
+    {file = "regex-2024.5.15-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e5bb9425fe881d578aeca0b2b4b3d314ec88738706f66f219c194d67179337cb"},
+    {file = "regex-2024.5.15-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:64c65783e96e563103d641760664125e91bd85d8e49566ee560ded4da0d3e704"},
+    {file = "regex-2024.5.15-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:cf2430df4148b08fb4324b848672514b1385ae3807651f3567871f130a728cc3"},
+    {file = "regex-2024.5.15-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:5397de3219a8b08ae9540c48f602996aa6b0b65d5a61683e233af8605c42b0f2"},
+    {file = "regex-2024.5.15-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:455705d34b4154a80ead722f4f185b04c4237e8e8e33f265cd0798d0e44825fa"},
+    {file = "regex-2024.5.15-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:b2b6f1b3bb6f640c1a92be3bbfbcb18657b125b99ecf141fb3310b5282c7d4ed"},
+    {file = "regex-2024.5.15-cp38-cp38-musllinux_1_2_aarch64.whl", hash = "sha256:3ad070b823ca5890cab606c940522d05d3d22395d432f4aaaf9d5b1653e47ced"},
+    {file = "regex-2024.5.15-cp38-cp38-musllinux_1_2_i686.whl", hash = "sha256:5b5467acbfc153847d5adb21e21e29847bcb5870e65c94c9206d20eb4e99a384"},
+    {file = "regex-2024.5.15-cp38-cp38-musllinux_1_2_ppc64le.whl", hash = "sha256:e6662686aeb633ad65be2a42b4cb00178b3fbf7b91878f9446075c404ada552f"},
+    {file = "regex-2024.5.15-cp38-cp38-musllinux_1_2_s390x.whl", hash = "sha256:2b4c884767504c0e2401babe8b5b7aea9148680d2e157fa28f01529d1f7fcf67"},
+    {file = "regex-2024.5.15-cp38-cp38-musllinux_1_2_x86_64.whl", hash = "sha256:3cd7874d57f13bf70078f1ff02b8b0aa48d5b9ed25fc48547516c6aba36f5741"},
+    {file = "regex-2024.5.15-cp38-cp38-win32.whl", hash = "sha256:e4682f5ba31f475d58884045c1a97a860a007d44938c4c0895f41d64481edbc9"},
+    {file = "regex-2024.5.15-cp38-cp38-win_amd64.whl", hash = "sha256:d99ceffa25ac45d150e30bd9ed14ec6039f2aad0ffa6bb87a5936f5782fc1569"},
+    {file = "regex-2024.5.15-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:13cdaf31bed30a1e1c2453ef6015aa0983e1366fad2667657dbcac7b02f67133"},
+    {file = "regex-2024.5.15-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:cac27dcaa821ca271855a32188aa61d12decb6fe45ffe3e722401fe61e323cd1"},
+    {file = "regex-2024.5.15-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:7dbe2467273b875ea2de38ded4eba86cbcbc9a1a6d0aa11dcf7bd2e67859c435"},
+    {file = "regex-2024.5.15-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:64f18a9a3513a99c4bef0e3efd4c4a5b11228b48aa80743be822b71e132ae4f5"},
+    {file = "regex-2024.5.15-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:d347a741ea871c2e278fde6c48f85136c96b8659b632fb57a7d1ce1872547600"},
+    {file = "regex-2024.5.15-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:1878b8301ed011704aea4c806a3cadbd76f84dece1ec09cc9e4dc934cfa5d4da"},
+    {file = "regex-2024.5.15-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:4babf07ad476aaf7830d77000874d7611704a7fcf68c9c2ad151f5d94ae4bfc4"},
+    {file = "regex-2024.5.15-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:35cb514e137cb3488bce23352af3e12fb0dbedd1ee6e60da053c69fb1b29cc6c"},
+    {file = "regex-2024.5.15-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:cdd09d47c0b2efee9378679f8510ee6955d329424c659ab3c5e3a6edea696294"},
+    {file = "regex-2024.5.15-cp39-cp39-musllinux_1_2_aarch64.whl", hash = "sha256:72d7a99cd6b8f958e85fc6ca5b37c4303294954eac1376535b03c2a43eb72629"},
+    {file = "regex-2024.5.15-cp39-cp39-musllinux_1_2_i686.whl", hash = "sha256:a094801d379ab20c2135529948cb84d417a2169b9bdceda2a36f5f10977ebc16"},
+    {file = "regex-2024.5.15-cp39-cp39-musllinux_1_2_ppc64le.whl", hash = "sha256:c0c18345010870e58238790a6779a1219b4d97bd2e77e1140e8ee5d14df071aa"},
+    {file = "regex-2024.5.15-cp39-cp39-musllinux_1_2_s390x.whl", hash = "sha256:16093f563098448ff6b1fa68170e4acbef94e6b6a4e25e10eae8598bb1694b5d"},
+    {file = "regex-2024.5.15-cp39-cp39-musllinux_1_2_x86_64.whl", hash = "sha256:e38a7d4e8f633a33b4c7350fbd8bad3b70bf81439ac67ac38916c4a86b465456"},
+    {file = "regex-2024.5.15-cp39-cp39-win32.whl", hash = "sha256:71a455a3c584a88f654b64feccc1e25876066c4f5ef26cd6dd711308aa538694"},
+    {file = "regex-2024.5.15-cp39-cp39-win_amd64.whl", hash = "sha256:cab12877a9bdafde5500206d1020a584355a97884dfd388af3699e9137bf7388"},
+    {file = "regex-2024.5.15.tar.gz", hash = "sha256:d3ee02d9e5f482cc8309134a91eeaacbdd2261ba111b0fef3748eeb4913e6a2c"},
+]
+
+[package.source]
+type = "legacy"
+url = "https://pypi.org/simple"
+reference = "pypi-public"
+
 [[package]]
 name = "requests"
 version = "2.32.3"
@@ -904,29 +1662,29 @@ reference = "pypi-public"
 
 [[package]]
 name = "ruff"
-version = "0.5.0"
+version = "0.5.1"
 description = "An extremely fast Python linter and code formatter, written in Rust."
 optional = false
 python-versions = ">=3.7"
 files = [
-    {file = "ruff-0.5.0-py3-none-linux_armv6l.whl", hash = "sha256:ee770ea8ab38918f34e7560a597cc0a8c9a193aaa01bfbd879ef43cb06bd9c4c"},
-    {file = "ruff-0.5.0-py3-none-macosx_10_12_x86_64.whl", hash = "sha256:38f3b8327b3cb43474559d435f5fa65dacf723351c159ed0dc567f7ab735d1b6"},
-    {file = "ruff-0.5.0-py3-none-macosx_11_0_arm64.whl", hash = "sha256:7594f8df5404a5c5c8f64b8311169879f6cf42142da644c7e0ba3c3f14130370"},
-    {file = "ruff-0.5.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:adc7012d6ec85032bc4e9065110df205752d64010bed5f958d25dbee9ce35de3"},
-    {file = "ruff-0.5.0-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:d505fb93b0fabef974b168d9b27c3960714d2ecda24b6ffa6a87ac432905ea38"},
-    {file = "ruff-0.5.0-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:9dc5cfd3558f14513ed0d5b70ce531e28ea81a8a3b1b07f0f48421a3d9e7d80a"},
-    {file = "ruff-0.5.0-py3-none-manylinux_2_17_ppc64.manylinux2014_ppc64.whl", hash = "sha256:db3ca35265de239a1176d56a464b51557fce41095c37d6c406e658cf80bbb362"},
-    {file = "ruff-0.5.0-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:b1a321c4f68809fddd9b282fab6a8d8db796b270fff44722589a8b946925a2a8"},
-    {file = "ruff-0.5.0-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:2c4dfcd8d34b143916994b3876b63d53f56724c03f8c1a33a253b7b1e6bf2a7d"},
-    {file = "ruff-0.5.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:81e5facfc9f4a674c6a78c64d38becfbd5e4f739c31fcd9ce44c849f1fad9e4c"},
-    {file = "ruff-0.5.0-py3-none-musllinux_1_2_aarch64.whl", hash = "sha256:e589e27971c2a3efff3fadafb16e5aef7ff93250f0134ec4b52052b673cf988d"},
-    {file = "ruff-0.5.0-py3-none-musllinux_1_2_armv7l.whl", hash = "sha256:d2ffbc3715a52b037bcb0f6ff524a9367f642cdc5817944f6af5479bbb2eb50e"},
-    {file = "ruff-0.5.0-py3-none-musllinux_1_2_i686.whl", hash = "sha256:cd096e23c6a4f9c819525a437fa0a99d1c67a1b6bb30948d46f33afbc53596cf"},
-    {file = "ruff-0.5.0-py3-none-musllinux_1_2_x86_64.whl", hash = "sha256:46e193b36f2255729ad34a49c9a997d506e58f08555366b2108783b3064a0e1e"},
-    {file = "ruff-0.5.0-py3-none-win32.whl", hash = "sha256:49141d267100f5ceff541b4e06552e98527870eafa1acc9dec9139c9ec5af64c"},
-    {file = "ruff-0.5.0-py3-none-win_amd64.whl", hash = "sha256:e9118f60091047444c1b90952736ee7b1792910cab56e9b9a9ac20af94cd0440"},
-    {file = "ruff-0.5.0-py3-none-win_arm64.whl", hash = "sha256:ed5c4df5c1fb4518abcb57725b576659542bdbe93366f4f329e8f398c4b71178"},
-    {file = "ruff-0.5.0.tar.gz", hash = "sha256:eb641b5873492cf9bd45bc9c5ae5320648218e04386a5f0c264ad6ccce8226a1"},
+    {file = "ruff-0.5.1-py3-none-linux_armv6l.whl", hash = "sha256:6ecf968fcf94d942d42b700af18ede94b07521bd188aaf2cd7bc898dd8cb63b6"},
+    {file = "ruff-0.5.1-py3-none-macosx_10_12_x86_64.whl", hash = "sha256:204fb0a472f00f2e6280a7c8c7c066e11e20e23a37557d63045bf27a616ba61c"},
+    {file = "ruff-0.5.1-py3-none-macosx_11_0_arm64.whl", hash = "sha256:d235968460e8758d1e1297e1de59a38d94102f60cafb4d5382033c324404ee9d"},
+    {file = "ruff-0.5.1-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:38beace10b8d5f9b6bdc91619310af6d63dd2019f3fb2d17a2da26360d7962fa"},
+    {file = "ruff-0.5.1-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:5e478d2f09cf06add143cf8c4540ef77b6599191e0c50ed976582f06e588c994"},
+    {file = "ruff-0.5.1-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:f0368d765eec8247b8550251c49ebb20554cc4e812f383ff9f5bf0d5d94190b0"},
+    {file = "ruff-0.5.1-py3-none-manylinux_2_17_ppc64.manylinux2014_ppc64.whl", hash = "sha256:3a9a9a1b582e37669b0138b7c1d9d60b9edac880b80eb2baba6d0e566bdeca4d"},
+    {file = "ruff-0.5.1-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:bdd9f723e16003623423affabcc0a807a66552ee6a29f90eddad87a40c750b78"},
+    {file = "ruff-0.5.1-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:be9fd62c1e99539da05fcdc1e90d20f74aec1b7a1613463ed77870057cd6bd96"},
+    {file = "ruff-0.5.1-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e216fc75a80ea1fbd96af94a6233d90190d5b65cc3d5dfacf2bd48c3e067d3e1"},
+    {file = "ruff-0.5.1-py3-none-musllinux_1_2_aarch64.whl", hash = "sha256:c4c2112e9883a40967827d5c24803525145e7dab315497fae149764979ac7929"},
+    {file = "ruff-0.5.1-py3-none-musllinux_1_2_armv7l.whl", hash = "sha256:dfaf11c8a116394da3b65cd4b36de30d8552fa45b8119b9ef5ca6638ab964fa3"},
+    {file = "ruff-0.5.1-py3-none-musllinux_1_2_i686.whl", hash = "sha256:d7ceb9b2fe700ee09a0c6b192c5ef03c56eb82a0514218d8ff700f6ade004108"},
+    {file = "ruff-0.5.1-py3-none-musllinux_1_2_x86_64.whl", hash = "sha256:bac6288e82f6296f82ed5285f597713acb2a6ae26618ffc6b429c597b392535c"},
+    {file = "ruff-0.5.1-py3-none-win32.whl", hash = "sha256:5c441d9c24ec09e1cb190a04535c5379b36b73c4bc20aa180c54812c27d1cca4"},
+    {file = "ruff-0.5.1-py3-none-win_amd64.whl", hash = "sha256:b1789bf2cd3d1b5a7d38397cac1398ddf3ad7f73f4de01b1e913e2abc7dfc51d"},
+    {file = "ruff-0.5.1-py3-none-win_arm64.whl", hash = "sha256:2875b7596a740cbbd492f32d24be73e545a4ce0a3daf51e4f4e609962bfd3cd2"},
+    {file = "ruff-0.5.1.tar.gz", hash = "sha256:3164488aebd89b1745b47fd00604fb4358d774465f20d1fcd907f9c0fc1b0655"},
 ]
 
 [package.source]
@@ -1027,6 +1785,22 @@ type = "legacy"
 url = "https://pypi.org/simple"
 reference = "pypi-public"
 
+[[package]]
+name = "typing-extensions"
+version = "4.12.2"
+description = "Backported and Experimental Type Hints for Python 3.8+"
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "typing_extensions-4.12.2-py3-none-any.whl", hash = "sha256:04e5ca0351e0f3f85c6853954072df659d0d13fac324d0072316b67d7794700d"},
+    {file = "typing_extensions-4.12.2.tar.gz", hash = "sha256:1a7ead55c7e559dd4dee8856e3a88b41225abfe1ce8df57b7c13915fe121ffb8"},
+]
+
+[package.source]
+type = "legacy"
+url = "https://pypi.org/simple"
+reference = "pypi-public"
+
 [[package]]
 name = "tzdata"
 version = "2024.1"
@@ -1065,7 +1839,76 @@ type = "legacy"
 url = "https://pypi.org/simple"
 reference = "pypi-public"
 
+[[package]]
+name = "watchdog"
+version = "4.0.1"
+description = "Filesystem events monitoring"
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "watchdog-4.0.1-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:da2dfdaa8006eb6a71051795856bedd97e5b03e57da96f98e375682c48850645"},
+    {file = "watchdog-4.0.1-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:e93f451f2dfa433d97765ca2634628b789b49ba8b504fdde5837cdcf25fdb53b"},
+    {file = "watchdog-4.0.1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:ef0107bbb6a55f5be727cfc2ef945d5676b97bffb8425650dadbb184be9f9a2b"},
+    {file = "watchdog-4.0.1-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:17e32f147d8bf9657e0922c0940bcde863b894cd871dbb694beb6704cfbd2fb5"},
+    {file = "watchdog-4.0.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:03e70d2df2258fb6cb0e95bbdbe06c16e608af94a3ffbd2b90c3f1e83eb10767"},
+    {file = "watchdog-4.0.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:123587af84260c991dc5f62a6e7ef3d1c57dfddc99faacee508c71d287248459"},
+    {file = "watchdog-4.0.1-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:093b23e6906a8b97051191a4a0c73a77ecc958121d42346274c6af6520dec175"},
+    {file = "watchdog-4.0.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:611be3904f9843f0529c35a3ff3fd617449463cb4b73b1633950b3d97fa4bfb7"},
+    {file = "watchdog-4.0.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:62c613ad689ddcb11707f030e722fa929f322ef7e4f18f5335d2b73c61a85c28"},
+    {file = "watchdog-4.0.1-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:d4925e4bf7b9bddd1c3de13c9b8a2cdb89a468f640e66fbfabaf735bd85b3e35"},
+    {file = "watchdog-4.0.1-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:cad0bbd66cd59fc474b4a4376bc5ac3fc698723510cbb64091c2a793b18654db"},
+    {file = "watchdog-4.0.1-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:a3c2c317a8fb53e5b3d25790553796105501a235343f5d2bf23bb8649c2c8709"},
+    {file = "watchdog-4.0.1-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:c9904904b6564d4ee8a1ed820db76185a3c96e05560c776c79a6ce5ab71888ba"},
+    {file = "watchdog-4.0.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:667f3c579e813fcbad1b784db7a1aaa96524bed53437e119f6a2f5de4db04235"},
+    {file = "watchdog-4.0.1-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:d10a681c9a1d5a77e75c48a3b8e1a9f2ae2928eda463e8d33660437705659682"},
+    {file = "watchdog-4.0.1-pp310-pypy310_pp73-macosx_10_9_x86_64.whl", hash = "sha256:0144c0ea9997b92615af1d94afc0c217e07ce2c14912c7b1a5731776329fcfc7"},
+    {file = "watchdog-4.0.1-pp310-pypy310_pp73-macosx_11_0_arm64.whl", hash = "sha256:998d2be6976a0ee3a81fb8e2777900c28641fb5bfbd0c84717d89bca0addcdc5"},
+    {file = "watchdog-4.0.1-pp38-pypy38_pp73-macosx_10_9_x86_64.whl", hash = "sha256:e7921319fe4430b11278d924ef66d4daa469fafb1da679a2e48c935fa27af193"},
+    {file = "watchdog-4.0.1-pp38-pypy38_pp73-macosx_11_0_arm64.whl", hash = "sha256:f0de0f284248ab40188f23380b03b59126d1479cd59940f2a34f8852db710625"},
+    {file = "watchdog-4.0.1-pp39-pypy39_pp73-macosx_10_9_x86_64.whl", hash = "sha256:bca36be5707e81b9e6ce3208d92d95540d4ca244c006b61511753583c81c70dd"},
+    {file = "watchdog-4.0.1-pp39-pypy39_pp73-macosx_11_0_arm64.whl", hash = "sha256:ab998f567ebdf6b1da7dc1e5accfaa7c6992244629c0fdaef062f43249bd8dee"},
+    {file = "watchdog-4.0.1-py3-none-manylinux2014_aarch64.whl", hash = "sha256:dddba7ca1c807045323b6af4ff80f5ddc4d654c8bce8317dde1bd96b128ed253"},
+    {file = "watchdog-4.0.1-py3-none-manylinux2014_armv7l.whl", hash = "sha256:4513ec234c68b14d4161440e07f995f231be21a09329051e67a2118a7a612d2d"},
+    {file = "watchdog-4.0.1-py3-none-manylinux2014_i686.whl", hash = "sha256:4107ac5ab936a63952dea2a46a734a23230aa2f6f9db1291bf171dac3ebd53c6"},
+    {file = "watchdog-4.0.1-py3-none-manylinux2014_ppc64.whl", hash = "sha256:6e8c70d2cd745daec2a08734d9f63092b793ad97612470a0ee4cbb8f5f705c57"},
+    {file = "watchdog-4.0.1-py3-none-manylinux2014_ppc64le.whl", hash = "sha256:f27279d060e2ab24c0aa98363ff906d2386aa6c4dc2f1a374655d4e02a6c5e5e"},
+    {file = "watchdog-4.0.1-py3-none-manylinux2014_s390x.whl", hash = "sha256:f8affdf3c0f0466e69f5b3917cdd042f89c8c63aebdb9f7c078996f607cdb0f5"},
+    {file = "watchdog-4.0.1-py3-none-manylinux2014_x86_64.whl", hash = "sha256:ac7041b385f04c047fcc2951dc001671dee1b7e0615cde772e84b01fbf68ee84"},
+    {file = "watchdog-4.0.1-py3-none-win32.whl", hash = "sha256:206afc3d964f9a233e6ad34618ec60b9837d0582b500b63687e34011e15bb429"},
+    {file = "watchdog-4.0.1-py3-none-win_amd64.whl", hash = "sha256:7577b3c43e5909623149f76b099ac49a1a01ca4e167d1785c76eb52fa585745a"},
+    {file = "watchdog-4.0.1-py3-none-win_ia64.whl", hash = "sha256:d7b9f5f3299e8dd230880b6c55504a1f69cf1e4316275d1b215ebdd8187ec88d"},
+    {file = "watchdog-4.0.1.tar.gz", hash = "sha256:eebaacf674fa25511e8867028d281e602ee6500045b57f43b08778082f7f8b44"},
+]
+
+[package.extras]
+watchmedo = ["PyYAML (>=3.10)"]
+
+[package.source]
+type = "legacy"
+url = "https://pypi.org/simple"
+reference = "pypi-public"
+
+[[package]]
+name = "zipp"
+version = "3.19.2"
+description = "Backport of pathlib-compatible object wrapper for zip files"
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "zipp-3.19.2-py3-none-any.whl", hash = "sha256:f091755f667055f2d02b32c53771a7a6c8b47e1fdbc4b72a8b9072b3eef8015c"},
+    {file = "zipp-3.19.2.tar.gz", hash = "sha256:bf1dcf6450f873a13e952a29504887c89e6de7506209e5b1bcc3460135d4de19"},
+]
+
+[package.extras]
+doc = ["furo", "jaraco.packaging (>=9.3)", "jaraco.tidelift (>=1.4)", "rst.linker (>=1.9)", "sphinx (>=3.5)", "sphinx-lint"]
+test = ["big-O", "importlib-resources", "jaraco.functools", "jaraco.itertools", "jaraco.test", "more-itertools", "pytest (>=6,!=8.1.*)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=2.2)", "pytest-ignore-flaky", "pytest-mypy", "pytest-ruff (>=0.2.1)"]
+
+[package.source]
+type = "legacy"
+url = "https://pypi.org/simple"
+reference = "pypi-public"
+
 [metadata]
 lock-version = "2.0"
 python-versions = ">=3.9.0,<3.13"
-content-hash = "98f35c44d62cc1181e9bb6bd8d26501afcb701451899edca5e08acc8c5d94af8"
+content-hash = "a7fd0d2340584b7c130de9d4a02006b15e076f1225da24a41a075abd9d74c2d1"
diff --git a/pyproject.toml b/pyproject.toml
index 8cb0849..fcf2dd7 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,5 +1,5 @@
 [tool.poetry]
-name="wp-site-extractor"
+name="wpextract"
 version="0.0.1"
 description="Create a dataset from the WordPress API"
 authors=["Freddy Heppell <frheppell1@sheffield.ac.uk>"]
@@ -35,10 +35,20 @@ pytest-datadir = "~1.5.0"
 pytest-mock = "~3.14.0"
 ruff = "^0.5.0"
 
+
+[tool.poetry.group.docs.dependencies]
+mkdocs-material = "^9.5.28"
+mkdocstrings = "^0.25.1"
+mkdocstrings-python = "^1.10.5"
+black = "^24.4.2"
+
 [build-system]
 requires = ["setuptools"]
 build-backend = "setuptools.build_meta"
 
+[tool.ruff]
+target-version = "py39"
+
 [tool.ruff.lint]
 select = [
     "E4",
diff --git a/src/extractor/__init__.py b/src/extractor/__init__.py
index e69de29..48cb237 100644
--- a/src/extractor/__init__.py
+++ b/src/extractor/__init__.py
@@ -0,0 +1,2 @@
+from .dl.downloader import WPDownloader as WPDownloader
+from .extract import WPExtractor as WPExtractor
diff --git a/src/extractor/cli/_dl.py b/src/extractor/cli/_dl.py
index 10948ba..46753d9 100644
--- a/src/extractor/cli/_dl.py
+++ b/src/extractor/cli/_dl.py
@@ -1,5 +1,6 @@
 from argparse import Namespace
 
+from extractor.cli._shared import _register_shared
 from extractor.dl.downloader import WPDownloader
 from extractor.dl.requestsession import RequestSession
 
@@ -27,6 +28,9 @@ def register_dl_parser(subparsers):
         default=None,
         help="Path to download media files, skipped if not supplied.",
     )
+
+    _register_shared(parser_dl)
+
     type_group = parser_dl.add_argument_group("data types")
     for dl_type in dl_types:
         type_group.add_argument(
diff --git a/src/extractor/cli/_extract.py b/src/extractor/cli/_extract.py
index fce9d55..fa69bb7 100644
--- a/src/extractor/cli/_extract.py
+++ b/src/extractor/cli/_extract.py
@@ -1,3 +1,4 @@
+from extractor.cli._shared import _register_shared
 from extractor.extract import WPExtractor
 from extractor.util.args import directory, empty_directory
 
@@ -30,8 +31,11 @@ def register_extract_parser(subparsers):
         required=False,
         default=None,
     )
+
     parser_extract.set_defaults(feature=True)
 
+    _register_shared(parser_extract)
+
 
 def do_extract(parser, args):
     """Perform the extract command."""
diff --git a/src/extractor/cli/_shared.py b/src/extractor/cli/_shared.py
new file mode 100644
index 0000000..88e7e01
--- /dev/null
+++ b/src/extractor/cli/_shared.py
@@ -0,0 +1,16 @@
+def _register_shared(parser):
+    log_group = parser.add_argument_group("logging")
+    log_group.add_argument(
+        "--log",
+        "-l",
+        help="File to log to. Will suppress stdout.",
+        type=str,
+        required=False,
+        default=None,
+    )
+    log_group.add_argument(
+        "--verbose",
+        "-v",
+        help="Increase log level to include debug logs",
+        action="store_true",
+    )
diff --git a/src/extractor/cli/cli.py b/src/extractor/cli/cli.py
index 24089a6..abf1954 100644
--- a/src/extractor/cli/cli.py
+++ b/src/extractor/cli/cli.py
@@ -22,7 +22,7 @@ def _get_version():
     return version("wp-site-extractor")
 
 
-def main() -> None:
+def _build_parser():
     """Entrypoint for CLI."""
     parser = argparse.ArgumentParser(
         prog="wpextract",
@@ -33,21 +33,6 @@ def main() -> None:
         "--version", action="version", version="%(prog)s " + _get_version()
     )
 
-    parser.add_argument(
-        "--log",
-        "-l",
-        help="File to log to. Will suppress stdout.",
-        type=str,
-        required=False,
-        default=None,
-    )
-    parser.add_argument(
-        "--verbose",
-        "-v",
-        help="Increase log level to include debug logs",
-        action="store_true",
-    )
-
     subparsers = parser.add_subparsers(
         dest="command",
         required=True,
@@ -57,6 +42,12 @@ def main() -> None:
     register_extract_parser(subparsers)
     register_dl_parser(subparsers)
 
+    return parser
+
+
+def main() -> None:
+    """Main entrypoint for CLI."""
+    parser = _build_parser()
     args = parser.parse_args()
 
     log_level = logging.DEBUG if args.verbose else logging.INFO
diff --git a/src/extractor/dl/__init__.py b/src/extractor/dl/__init__.py
index 2ae2839..8febd61 100644
--- a/src/extractor/dl/__init__.py
+++ b/src/extractor/dl/__init__.py
@@ -1 +1 @@
-pass
+from .requestsession import RequestSession as RequestSession
diff --git a/src/extractor/dl/downloader.py b/src/extractor/dl/downloader.py
index 282ffa0..242650c 100644
--- a/src/extractor/dl/downloader.py
+++ b/src/extractor/dl/downloader.py
@@ -9,6 +9,8 @@
 
 
 class WPDownloader:
+    """Manages the download of data from a WordPress site."""
+
     def __init__(
         self,
         target: str,
@@ -16,6 +18,14 @@ def __init__(
         data_types: List[str],
         session: Optional[RequestSession] = None,
     ):
+        """Initializes the WPDownloader object.
+
+        Args:
+            target: the target WordPress site URL
+            out_path: the output path for the downloaded data
+            data_types: set of data types to download
+            session : request session. Will be created from default constructor if not provided.
+        """
         self.target = target
         self.out_path = out_path
         self.data_types = data_types
@@ -49,7 +59,7 @@ def download(self):
         if "media" in self.data_types:
             self._list_obj(WPApi.MEDIA)
 
-    def download_media_files(self, session: RequestSession, dest):
+    def download_media_files(self, session: RequestSession, dest: str):
         """Download site media files.
 
         Args:
diff --git a/src/extractor/dl/requestsession.py b/src/extractor/dl/requestsession.py
index b929f9d..0029cfa 100644
--- a/src/extractor/dl/requestsession.py
+++ b/src/extractor/dl/requestsession.py
@@ -23,7 +23,7 @@
 import random
 import time
 from http.cookies import SimpleCookie
-from typing import Tuple
+from typing import Tuple, Union
 
 import requests
 from requests.adapters import HTTPAdapter
@@ -171,7 +171,7 @@ def wait(self):
         time.sleep(self.wait_s * wait_factor)
 
 
-AuthorizationType = Tuple[str, str] | HTTPBasicAuth | HTTPDigestAuth
+AuthorizationType = Union[Tuple[str, str], HTTPBasicAuth, HTTPDigestAuth]
 
 
 class RequestSession:
@@ -194,7 +194,7 @@ def __init__(
         Args:
             proxy: a dict containing a proxy server string for HTTP and/or HTTPS connection
             cookies: a string in the format of the Cookie header
-            authorization: a tuple containing login and password or requests.auth.HTTPBasicAuth for basic authentication or requests.auth.HTTPDigestAuth for NTLM-like authentication
+            authorization: a tuple containing login and password or [`requests.auth.HTTPBasicAuth`][requests.auth.HTTPBasicAuth] for basic authentication or [`requests.auth.HTTPDigestAuth`][requests.auth.HTTPDigestAuth] for NTLM-like authentication
             timeout: maximum time in seconds to wait for a response before giving up
             wait: wait time in seconds between requests, None to not wait
             random_wait: If true, the wait time between requests is multiplied by a random factor between 0.5 and 1.5
diff --git a/src/extractor/extract.py b/src/extractor/extract.py
index 73f6581..1109a86 100644
--- a/src/extractor/extract.py
+++ b/src/extractor/extract.py
@@ -23,21 +23,30 @@
 
 
 class WPExtractor:
-    """Main class to extract data."""
+    """Manages the extraction of data from a WordPress site."""
 
     json_root: Path
     scrape_root: Optional[Path]
     json_prefix: Optional[str]
+    translation_pickers: Optional[PickerListType]
+
     link_registry: LinkRegistry
+    """Registry of known URLs and their corresponding data items."""
 
     posts: Optional[DataFrame]
+    """DataFrame of extracted posts."""
     media: Optional[DataFrame]
+    """DataFrame of extracted media."""
     tags: Optional[DataFrame]
+    """DataFrame of extracted tags."""
     categories: Optional[DataFrame]
+    """DataFrame of extracted categories."""
     users: Optional[DataFrame]
+    """DataFrame of extracted users."""
     pages: Optional[DataFrame]
+    """DataFrame of extracted pages."""
+
     scrape_url_mapping: Dict[str, Path]
-    translation_pickers: Optional[PickerListType]
 
     def __init__(
         self,
@@ -131,7 +140,11 @@ def _resolve_post_links(self):
             self.posts = resolve_post_translations(self.link_registry, self.posts)
 
     def export(self, out_dir: Path) -> None:
-        """Save scrape results to ``out_dir``."""
+        """Save scrape results!
+
+        Args:
+            out_dir: Path to output directory
+        """
         logging.info("Beginning export")
         export_df(self.posts, out_dir / self._prefix_filename("posts.json"))
         export_df(self.pages, out_dir / self._prefix_filename("pages.json"))
diff --git a/src/extractor/extractors/data/links.py b/src/extractor/extractors/data/links.py
index 4c0d8a5..bcfe772 100644
--- a/src/extractor/extractors/data/links.py
+++ b/src/extractor/extractors/data/links.py
@@ -37,7 +37,7 @@ def __init__(self):
         self.links = []
 
     def add_linkable(
-        self, url: str, data_type: str, idx: str, _refresh_cache=True
+        self, url: str, data_type: str, idx: str, _refresh_cache: bool = True
     ) -> None:
         """Add a single linkable item to the registry.
 
diff --git a/src/extractor/parse/translations/__init__.py b/src/extractor/parse/translations/__init__.py
index f27bb5d..3577814 100644
--- a/src/extractor/parse/translations/__init__.py
+++ b/src/extractor/parse/translations/__init__.py
@@ -1,5 +1,4 @@
-from ._extractor import (
-    PickerListType,  # noqa: F401
-    extract_translations,  # noqa: F401
-)
-from ._pickers import LangPicker  # noqa: F401
+from ._extractor import PickerListType as PickerListType
+from ._extractor import extract_translations as extract_translations
+from ._pickers import LangPicker as LangPicker
+from ._resolver import TranslationLink as TranslationLink
diff --git a/src/extractor/parse/translations/_pickers.py b/src/extractor/parse/translations/_pickers.py
index 3b19c63..9ff40e7 100644
--- a/src/extractor/parse/translations/_pickers.py
+++ b/src/extractor/parse/translations/_pickers.py
@@ -9,11 +9,19 @@
 
 
 class LangPicker(ABC):
-    """Abstract class of a language picker style."""
+    """Abstract class of a language picker style.
 
+    Support for a new language picker can be added by creating a new class inheriting from this one.
+    """
+
+    page_doc: BeautifulSoup
+    """The document to extract the language picker from."""
     root_el: Tag
+    """The root element of the language picker, populated if [`LangPicker.matches`][extractor.parse.translations.LangPicker.matches] is succesful."""
     translations: List[TranslationLink]
+    """A list of translation links, populated by calling [`LangPicker.add_translation`][extractor.parse.translations.LangPicker.add_translation] within [`LangPicker.extract`][extractor.parse.translations.LangPicker.extract]."""
     current_language: Language
+    """The current language of the page, populated by calling [`LangPicker.set_current_lang`][extractor.parse.translations.LangPicker.set_current_lang] within [`LangPicker.extract`][extractor.parse.translations.LangPicker.extract]."""
 
     def __init__(self, page_doc: BeautifulSoup):
         """Inits a language picker searcher.
@@ -50,11 +58,10 @@ def matches(self) -> bool:
     def get_root(self) -> PageElement:
         """Retrieve the root element of the translation picker.
 
-        Should contain the element which indicates the current language
-        and lists translations.
+        Using the [`LangPicker.page_doc`][extractor.parse.translations.LangPicker.page_doc] attribute (a [`bs4.BeautifulSoup`][bs4.BeautifulSoup] object representing the whole page), the root element of the picker shoudl be found and returned.
 
         Returns:
-            The root element.
+            The root element, or None if this picker is not found on the page.
         """
         pass
 
diff --git a/src/extractor/parse/translations/_resolver.py b/src/extractor/parse/translations/_resolver.py
index 6646027..585ab84 100644
--- a/src/extractor/parse/translations/_resolver.py
+++ b/src/extractor/parse/translations/_resolver.py
@@ -10,7 +10,9 @@ class TranslationLink(ResolvableLink):
     """A link to an alternative version of this article in a different language."""
 
     lang: str
+    """Raw language code."""
 
-    def __post_init__(self) -> None:
-        """Parse string lang into normalised language."""
-        self.language = Language.get(self.lang, normalize=True)
+    @property
+    def language(self) -> Language:
+        """Parsed and normalized language. Populated automatically post-init."""
+        return Language.get(self.lang, normalize=True)
diff --git a/tests/parse/translations/test_pickers/generic_polylang.html b/tests/parse/translations/test_pickers/generic_polylang.html
index 5f29838..c08ac22 100644
--- a/tests/parse/translations/test_pickers/generic_polylang.html
+++ b/tests/parse/translations/test_pickers/generic_polylang.html
@@ -10,7 +10,7 @@
     <title>Generic Polylang-Like Test</title>
   </head>
   <body>
-    <nav>
+    <nav>  <!-- --8<-- [start:struct] -->
       <div class="header-lang_switcher switcher-ltr">
         <div class="current-lang-switcher">
           <img src="https://example.org/flag_en.svg" alt="flag-en" />
@@ -52,6 +52,6 @@
           </li>
         </ul>
       </div>
-    </nav>
+    </nav>  <!-- --8<-- [end:struct] -->
   </body>
 </html>
diff --git a/tests/parse/translations/test_pickers/polylang.html b/tests/parse/translations/test_pickers/polylang.html
index 4ba6072..327ada5 100644
--- a/tests/parse/translations/test_pickers/polylang.html
+++ b/tests/parse/translations/test_pickers/polylang.html
@@ -10,7 +10,7 @@
     <title>Polylang Test</title>
   </head>
   <body>
-    <aside>
+    <aside> <!-- --8<-- [start:struct] -->
       <div id="polylang-2" class="widget widget_polylang">
         <ul>
           <li
@@ -97,6 +97,6 @@
           </li>
         </ul>
       </div>
-    </aside>
+    </aside> <!-- --8<-- [end:struct] -->
   </body>
 </html>