Marker-Web
This is a Flask-backend and Vue.js frontend for the marker library. The
Try it out with dummy data! (Mobile friendly too)
Running marker-web spins up a local server and hosts the frontend so you can use the marking utilities with a GUI. The layout makes it trivial to package this as a standalone app if needed.
Disclaimer: This is still in development. There most definitely are UI quirks and missing features. If you find any, please open an Issue on GitHub and let me know!
How to install
There are 2 ways to install this marker.
Using PIP
This is by far the recommended way of installing this utility. Simply run:
pip install marker-web
Build from source
Alternatively, if you want to develop, you will need to build from source:
git clone https://github.com/mustafaquraish/marker-web
cd marker-web
python setup.py install
How to use
Locally
In it's simplest form, you can start up the server with:
$ marker-web
You can also pass in the same arguments as marker CLI.
Currently, if either:
- Your configuration file is not is not
assgn_dir/config.yml, or - Your
src_diris not the same asassgn_dir
Then you must pass in the correct arguments when running marker-web. Otherwise, the interface provides a little file explorer which lets you pick assgn_dir (and can infer the other two arguments)
By default, anyone else logged in on the machine can access the endpoints. To prevent this, you can run in authenticated mode with:
$ marker-web --auth
This will print out a random token which needs to be entered in the frontend to be able to access any information. A link is also print out with the token embedded in it, so you can just open that URL in your browser.
By default, the server runs on port 6275. You can specify an alternate port using:
$ marker-web --port PORT
Remote (Experimental)
Note: This requires the remote machine to have marker-web installed, and for you to have SSH access to it.
If you want to run the marker on a remote machine, but show the frontend on your local browser, this can be done via port-forwarding over SSH. For full flexibility, you want to do this manually. However, if you are fine with some defaults, you can run:
$ marker-web --remote HOST
which is approximately the same as running:
$ ssh -L PORT:localhost:PORT HOST marker-web --auth
For the features available to you in the GUI, you should read through the documentation for the marker CLI. Most things should be self-explanatory.
Development notes:
- The
frontenddirectory contains the Vue frontend - The
marker_webdirectory contains the marker_server - The
extradirectory contains some files to build a standalone app (on MacOS at least)
Metadata
Release files for marker-web 1.1.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| marker_web-1.1.2-py3-none-any.whl | Python 3 | none | any | Details for marker_web-1.1.2-py3-none-any.whl |
Release files / marker_web-1.1.2-py3-none-any.whl
| Download URL | marker_web-1.1.2-py3-none-any.whl |
|---|---|
| Size | 1.2 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
151633ea021657774bd26e59bc0871f9f3b3bc82c142b011c00f6325ab2a8a8b
|
|
BLAKE2b-256 checksum How to use checksums |
b1efaba99a234b44e78d5248e1ada704de0e867d593c41d9dabe5ab5b7094435
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/54.2.0 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.9.4
|
Security for marker-web 1.1.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.