tex2lambda —> in2lambda

Author: harens

.github/workflows/test.yml

@@ -25,10 +25,10 @@ jobs:
       - name: Linting Checks
         run: |
           black --check .
-          isort --check-only tex2lambda docs
-          pydocstyle --convention=google tex2lambda
+          isort --check-only in2lambda docs
+          pydocstyle --convention=google in2lambda
       - name: pytest
-        run: pytest --cov-report=xml:coverage.xml --cov=tex2lambda --doctest-modules tex2lambda
+        run: pytest --cov-report=xml:coverage.xml --cov=in2lambda --doctest-modules in2lambda
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v3
         with:

Dockerfile

@@ -10,14 +10,14 @@ ENV PYTHONUNBUFFERED=1 \
 WORKDIR /app
 
 # README required since referenced by pyproject.toml
-COPY ./pyproject.toml ./README.md ./tex2lambda /app/
-COPY ./tex2lambda /app/tex2lambda/
+COPY ./pyproject.toml ./README.md ./in2lambda /app/
+COPY ./in2lambda /app/in2lambda/
 
 RUN pip install .
 
 FROM python:3.11.4-alpine
 
-COPY --from=python-builder /usr/local/bin/tex2lambda /usr/local/bin/tex2lambda
+COPY --from=python-builder /usr/local/bin/in2lambda /usr/local/bin/in2lambda
 COPY --from=python-builder /usr/local/lib/python3.11/site-packages /usr/local/lib/python3.11/site-packages
 
 RUN apk add --no-cache pandoc

README.md

@@ -1,11 +1,11 @@
-# tex2lambda
+# in2lambda
 
-![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/lambda-feedback/tex2lambda/deploy-docs.yml?style=flat-square&logo=github&label=docs)
+![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/lambda-feedback/in2lambda/deploy-docs.yml?style=flat-square&logo=github&label=docs)
 
-tex2lambda is a Python command line tool and library that automagically uploads questions to [Lambda Feedback](https://lambdafeedback.com/).
+in2lambda is a Python command line tool and library that automagically uploads questions to [Lambda Feedback](https://lambdafeedback.com/).
 
-Find out more in the [documentation](https://lambda-feedback.github.io/tex2lambda/).
+Find out more in the [documentation](https://lambda-feedback.github.io/in2lambda/).
 
 ```
-$ pip install tex2lambda
+$ pip install in2lambda
 ```

docs/source/conf.py

@@ -25,7 +25,7 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = "tex2lambda"
+project = "in2lambda"
 author = "Lambda Feedback"
 copyright = f"{datetime.now().year}, {author}"
 
@@ -51,7 +51,7 @@
 
 myst_enable_extensions = ["colon_fence"]
 
-ogp_site_url = "https://lambda-feedback.github.io/tex2lambda/"
+ogp_site_url = "https://lambda-feedback.github.io/in2lambda/"
 ogp_image = "./_static/icons/social.png"
 ogp_social_cards = {
     "image": "./_static/icons/social.png",
@@ -68,7 +68,7 @@
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_title = "tex2lambda"
+html_title = "in2lambda"
 html_theme = "furo"
 html_favicon = "./_static/icons/favicon.png"
 html_theme_options = {
@@ -78,7 +78,7 @@
     "footer_icons": [
         {
             "name": "GitHub",
-            "url": "https://github.com/lambda-feedback/tex2lambda",
+            "url": "https://github.com/lambda-feedback/in2lambda",
             "html": """
                 <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
                     <path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path>

docs/source/contributing/documentation.md

@@ -26,7 +26,7 @@ When writing a new page, be sure to include it in a tree!
 
 ## Filters
 
-The [documentation for the filters](../filters/index) is auto-generated for each one in `tex2lambda/filters` every time the docs are built.
+The [documentation for the filters](../filters/index) is auto-generated for each one in `in2lambda/filters` every time the docs are built.
 
 The process uses data from two files present in each filter's source code directory:
 
@@ -38,17 +38,17 @@ There should then be no need to write explicit documentation for any new filters
 :::{admonition} How the Auto-Generation Works
 :class: dropdown
 
-A script was written in `docs/filters.py` that generate the docs. It's called in `docs/conf.py` which is loaded when building the docs. The filters script goes through each directory present in `tex2lambda/filters` to determine the docstring (via `__doc__`) and compile the LaTeX file present.
+A script was written in `docs/filters.py` that generate the docs. It's called in `docs/conf.py` which is loaded when building the docs. The filters script goes through each directory present in `in2lambda/filters` to determine the docstring (via `__doc__`) and compile the LaTeX file present.
 
 Compiled PDFs are stored in `docs/_static/pdfs` and the generated RST docs are put in `docs/filters/_autosummary`. `docs/filters/index.md` includes these autogenerated files in the website via a [table of contents tree](https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-toctree).
 :::
 
 ## Reference
 
-The [CLT reference](../reference/command-line) is generated based on the output of `tex2lambda --help` via [sphinx-click](https://sphinx-click.readthedocs.io/en/latest/).
+The [CLT reference](../reference/command-line) is generated based on the output of `in2lambda --help` via [sphinx-click](https://sphinx-click.readthedocs.io/en/latest/).
 
 [API documentation](../reference/library) is built based on [docstrings](https://peps.python.org/pep-0257/#what-is-a-docstring) found within the code base. This is done using [sphinx.ext.autosummary](https://www.sphinx-doc.org/en/master/usage/extensions/autosummary.html).
 
 :::{tip}
-See the [Module docs](../reference/_autosummary/tex2lambda.api.module.Module) and the source code buttons on its page for good examples on how to write the docstrings effectively.
+See the [Module docs](../reference/_autosummary/in2lambda.api.module.Module) and the source code buttons on its page for good examples on how to write the docstrings effectively.
 :::

docs/source/contributing/high_level.md

@@ -2,12 +2,12 @@
 
 ```{eval-rst}
 .. graphviz:: ../diagrams/workflow.dot
-    :alt: tex2lambda Workflow Overview Diagram
+    :alt: in2lambda Workflow Overview Diagram
     :align: right
 ```
 
 A [pandoc filter](https://pandoc.org/filters.html) is written using [panflute](https://github.com/sergiocorreia/panflute) to parse different file structures. For instance, maybe questions are denoted using lists, or the answers directly follow the question.
 
-Whilst running the filter, python functions which are part of the tex2lambda API help denote where text extracted from the file should go in a Lambda Feedback question. This is represented internally as separate objects for each part, question and module.
+Whilst running the filter, python functions which are part of the in2lambda API help denote where text extracted from the file should go in a Lambda Feedback question. This is represented internally as separate objects for each part, question and module.
 
 Finally, `json_convert` takes the questions in a python module object and converts it into zip files that can be imported through Lambda Feedback.

docs/source/contributing/installation.md

@@ -4,11 +4,11 @@
 The standard installation method can be found in the [Quickstart](../quickstart). These instructions are for development purposes.
 :::
 
-Fork the [GitHub project](https://github.com/lambda-feedback/tex2lambda) to your account. Then, run the following with your GitHub handle in place of GITHUB_NAME:
+Fork the [GitHub project](https://github.com/lambda-feedback/in2lambda) to your account. Then, run the following with your GitHub handle in place of GITHUB_NAME:
 
 ```shell
-$ git clone https://github.com/GITHUB_NAME/tex2lambda
-$ cd tex2lambda
+$ git clone https://github.com/GITHUB_NAME/in2lambda
+$ cd in2lambda
 ```
 
 The project can then be installed using [poetry](https://python-poetry.org/):
@@ -17,13 +17,13 @@ The project can then be installed using [poetry](https://python-poetry.org/):
 $ poetry install
 $ poetry shell
 $ pre-commit install
-$ tex2lambda --help
+$ in2lambda --help
 ```
 
 :::{admonition} Using pip
 :class: dropdown
 
-Using pip alone is not recommended since it only installs the necessary dependencies to run `tex2lambda`, without any developer/documentation libraries. However, it could be useful for testing small modifications.
+Using pip alone is not recommended since it only installs the necessary dependencies to run `in2lambda`, without any developer/documentation libraries. However, it could be useful for testing small modifications.
 
 First, we create and activate a [virtual environment](https://docs.python.org/3/library/venv.html):
 
@@ -36,6 +36,6 @@ Then install in [editable mode](https://pip.pypa.io/en/stable/topics/local-proje
 
 ```shell
 $ pip install -e .
-$ tex2lambda --help
+$ in2lambda --help
 ```
 :::

docs/source/diagrams/workflow.dot

@@ -1,12 +1,12 @@
-digraph tex2lambda_workflow {
-    subgraph cluster_tex2lambda {
+digraph in2lambda_workflow {
+    subgraph cluster_in2lambda {
         color = blue;
 
         labelloc = "b";
         labeljust = "l";
 
         style = "rounded";
-        label = <<b>tex2lambda</b>>;
+        label = <<b>in2lambda</b>>;
 
         filters [label = "Pandoc Filter";fillcolor = "#F0F0F0";];
         python_object [label = <<table border='0' cellborder='1' cellspacing='0' cellpadding='5'>

docs/source/filters.py

@@ -5,7 +5,7 @@
 import subprocess
 from pathlib import Path
 
-import tex2lambda.filters
+import in2lambda.filters
 
 
 def generate_filters_docs():
@@ -21,16 +21,16 @@ def generate_filters_docs():
 
     filters = (
         i.name
-        for i in pkgutil.iter_modules(tex2lambda.filters.__path__)
+        for i in pkgutil.iter_modules(in2lambda.filters.__path__)
         if i.name[0] != "_"
     )
 
     for filter_name in filters:
         filter_module = importlib.import_module(
-            f"tex2lambda.filters.{filter_name}.filter"
+            f"in2lambda.filters.{filter_name}.filter"
         )
 
-        relative_directory = f"../../../../tex2lambda/filters/{filter_name}"
+        relative_directory = f"../../../../in2lambda/filters/{filter_name}"
         """Where to find the filter's directory relative to `autosummary_directory`.
 
         For some reason, literalinclude requires it to be relative.

docs/source/filters/index.md

@@ -1,6 +1,6 @@
 # 📚 Filters
 
-Behind the scenes, tex2lambda makes use of [pandoc filters](https://pandoc.org/filters.html) to parse the question files.
+Behind the scenes, in2lambda makes use of [pandoc filters](https://pandoc.org/filters.html) to parse the question files.
 
 :::{admonition} Why not manually parse the questions?
 :class: dropdown