|
1 | | -# content-conversion |
2 | | -A Python library and CLT for converting LaTeX documents into Lambda Feedback format. |
3 | | - |
4 | | -## Installation |
5 | | - |
6 | | -First, ensure that [pandoc](https://pandoc.org/) is installed. |
7 | | - |
8 | | -### PyPi |
9 | | - |
10 | | -``` |
11 | | -$ pip install https://github.com/lambda-feedback/content-conversion/archive/main.zip |
12 | | -$ tex2lambda --help |
13 | | -``` |
14 | | - |
15 | | -It can also be installed via [pipx](https://pypa.github.io/pipx/). |
16 | | - |
17 | | -## Usage |
18 | | - |
19 | | -<!--- TODO: Automate this help output. --> |
20 | | - |
21 | | -``` |
22 | | -$ tex2lambda --help |
23 | | -
|
24 | | - Usage: tex2lambda [OPTIONS] TEX_FILE {Materials} |
25 | | -
|
26 | | - Takes in a TEX_FILE for a given SUBJECT and produces Lambda Feedback |
27 | | - compatible json/zip files. |
28 | | -
|
29 | | -╭─ Options ─────────────────────────────────────────────────────────────────╮ |
30 | | -│ --out -o PATH Directory to output json/zip files to. [default: ./out] │ |
31 | | -│ --help Show this message and exit. │ |
32 | | -╰───────────────────────────────────────────────────────────────────────────╯ |
33 | | -
|
34 | | - See the docs at https://lambda-feedback.github.io/user-documentation/ for |
35 | | - more details. |
36 | | -``` |
37 | | - |
38 | | -For instance, the following takes in a Materials question sheet and produces JSON/ZIP files to `./out`: |
39 | | - |
40 | | -``` |
41 | | -$ tex2lambda problemsA_v2.7.tex Materials |
42 | | -``` |
43 | | - |
44 | | -Warnings will be generated if the image directory isn't in the correct location relative to the LaTeX file. |
45 | | - |
46 | | -## Local Development |
47 | | - |
48 | | -You can obtain the development version by cloning the repository: |
49 | | - |
50 | | -``` |
51 | | -$ git clone https://github.com/lambda-feedback/content-conversion |
52 | | -$ cd content-conversion |
53 | | -``` |
54 | | - |
55 | | -The project can then be installed such that any local changes are applied automatically. |
56 | | - |
57 | | -### Poetry |
58 | | - |
59 | | -Install [poetry](https://python-poetry.org/) and then run the following: |
60 | | - |
61 | | -``` |
62 | | -$ poetry install |
63 | | -$ poetry shell |
64 | | -$ tex2lambda --help |
65 | | -``` |
66 | | - |
67 | | -### pip |
68 | | - |
69 | | -First, we create and activate a [virtual environment](https://docs.python.org/3/library/venv.html): |
70 | | - |
71 | | -``` |
72 | | -$ python -m venv env |
73 | | -$ source env/bin/activate |
74 | | -``` |
75 | | - |
76 | | -Then we install in [editable mode](https://pip.pypa.io/en/stable/topics/local-project-installs/#editable-installs): |
77 | | - |
78 | | -``` |
79 | | -$ pip install -e . |
80 | | -$ tex2lambda --help |
81 | | -``` |
| 1 | +<div align="center"> |
| 2 | + <h1>tex2lambda</h1> |
| 3 | + <img alt="GitHub Workflow Status (with event)" src="https://img.shields.io/github/actions/workflow/status/lambda-feedback/tex2lambda/deploy-docs.yml?style=flat-square&logo=github&label=docs"> |
| 4 | + <br><br> |
| 5 | + <em>Automagically uploads questions to Lambda Feedback so you don't have to.</em> |
| 6 | +</div> |
0 commit comments