Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/centrefordigitalhumanities/parseport
Dutch sentence parser for Spindle + Æthel (and maybe others in the future).
https://github.com/centrefordigitalhumanities/parseport
Last synced: 10 days ago
JSON representation
Dutch sentence parser for Spindle + Æthel (and maybe others in the future).
- Host: GitHub
- URL: https://github.com/centrefordigitalhumanities/parseport
- Owner: CentreForDigitalHumanities
- License: bsd-3-clause
- Created: 2023-07-27T07:28:08.000Z (over 1 year ago)
- Default Branch: develop
- Last Pushed: 2024-09-16T15:36:52.000Z (2 months ago)
- Last Synced: 2024-09-17T19:11:22.934Z (about 2 months ago)
- Language: TypeScript
- Size: 22.4 MB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 39
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ParsePort
[](https://github.com/UUDigitalHumanitieslab/parseport/actions)
ParsePort is an interface for the [Spindle](https://github.com/konstantinosKokos/spindle) parser using the [Æthel](https://github.com/konstantinosKokos/aethel) library, both developed by dr. Konstantinos Kogkalidis as part of a research project conducted with prof. dr. Michaël Moortgat at Utrecht University. Other parsers may be added in the future.
## Running this application in Docker
In order to run this application you need a working installation of Docker and an internet connection. You will also need the source code from two other repositories, `spindle-server` and `latex-service` to be present in the same directory as the `parseport` source code.
In addition, you need to add a configuration file named `.env` to the root directory of this project with at least the following setting.
```
DJANGO_SECRET_KEY=...
```
In overview, your file structure should be as follows.
```
├── spindle-server
| └── Dockerfile
| └── model_weights.pt
|
├── latex-service
| └── Dockerfile
|
└── parseport (this project)
├── compose.yaml
├── .env
├── frontend
| └── Dockerfile
└── backend
├── Dockerfile
└── aethel.pickle
```
Note that you will need two data files in order to run this project.
- `model_weights.pt` should be put in the root directory of the `spindle-server` project. It can be downloaded from _Yoda-link here_.
- `aethel.pickle` should live at `parseport/backend/`. You can find it in the zip archive [here](https://github.com/konstantinosKokos/aethel/tree/stable/data).
This application can be run in both `production` and `development` mode. Either mode will start a network of five containers.
| Name | Description |
|--------------|---------------------------------------------------|
| `nginx` | Entry point and reverse proxy, exposes port 5000. |
| `pp-ng` | The frontend server (Angular). |
| `pp-dj` | The backend/API server (Django). |
| `pp-spindle` | The server hosting the Spindle parser. |
| `pp-latex` | The server hosting a LaTeX compiler. |
Start the Docker network in **development mode** by running the following command in your terminal.
```
docker compose --profile dev up --build -d
```
For **production mode**, run the following instead.
```
docker compose --profile prod up --build -d
```
The Spindle server needs to download several files before the parser is ready to receive. You should wait a few minutes until the message *App is ready!* appears in the Spindle container logs.
Open your browser and visit your project at http://localhost:5000 to view the application.
## Preparing for development
Note that the Aethel dataset will be loaded in every time the backend server restarts. To avoid slow feedback loops in a development environment, consider running `python manage.py create_aethel_subset` before starting the development server. This will take create a much smaller subset that takes less than a second to load.
## Before you start
You need to install the following software:
- PostgreSQL >= 10, client, server and C libraries
- Python >= 3.8, <= 3.10
- virtualenv
- WSGI-compatible webserver (deployment only)
- [Visual C++ for Python][1] (Windows only)
- Node.js >= 14.20.0
- Yarn
- [WebDriver][2] for at least one browser (only for functional testing)
[1]: https://wiki.python.org/moin/WindowsCompilers
[2]: https://pypi.org/project/selenium/#drivers
## How it works
This project integrates three isolated subprojects, each inside its own subdirectory with its own code, package dependencies and tests:
- **backend**: the server side web application based on [Django][3] and [DRF][4]
- **frontend**: the client side web application based on [Angular](https://angular.io)
- **functional-tests**: the functional test suite based on [Selenium][6] and [pytest][7]
[3]: https://www.djangoproject.com
[4]: https://www.django-rest-framework.org
[6]: https://www.selenium.dev/documentation/webdriver/
[7]: https://docs.pytest.org/en/latest/
Each subproject is configurable from the outside. Integration is achieved using "magic configuration" which is contained inside the root directory together with this README. In this way, the subprojects can stay truly isolated from each other.
If you are reading this README, you'll likely be working with the integrated project as a whole rather than with one of the subprojects in isolation. In this case, this README should be your primary source of information on how to develop or deploy the project. However, we recommend that you also read the "How it works" section in the README of each subproject.
## Development
### Quickstart
First time after cloning this project:
```console
$ python bootstrap.py
```
Running the application in [development mode][8] (hit ctrl-C to stop):
```console
$ yarn start
```
This will run the backend and frontend applications, as well as their unittests, and watch all source files for changes. You can visit the frontend on http://localhost:8000/, the browsable backend API on http://localhost:8000/api/ and the backend admin on http://localhost:8000/admin/. On every change, unittests rerun, frontend code rebuilds and open browser tabs refresh automatically (livereload).
[8]: #development-mode-vs-production-mode
### Recommended order of development
For each new feature, we suggested that you work through the steps listed below. This could be called a back-to-front or "bottom up" order. Of course, you may have reasons to choose otherwise. For example, if very precise specifications are provided, you could move step 8 to the front for a more test-driven approach.
Steps 1–5 also include updating the unittests. Only functions should be tested, especially critical and nontrivial ones.
1. Backend model changes including migrations.
2. Backend serializer changes and backend admin changes.
3. Backend API endpoint changes.
4. Frontend model changes.
5. Other frontend unit changes (templates, views, routers, FSMs).
6. Frontend integration (globals, event bindings).
7. Run functional tests, repair broken functionality and broken tests.
8. [Add functional tests][9] for the new feature.
9. Update technical documentation.
[9]: functional-tests/README.md#writing-tests
For release branches, we suggest the following checklist.
1. Bump the version number in the `package.json` next to this README.
2. Run the functional tests in production mode, fix bugs if necessary.
3. Try using the application in production mode, look for problems that may have escaped the tests.
4. Add regression tests (unit or functional) that detect problems from step 3.
5. Work on the code until new regression tests from step 4 pass.
6. Optionally, repeat steps 2–5 with the application running in a real deployment setup (see [Deployment](#deployment)).
### Commands for common tasks
The `package.json` next to this README defines several shortcut commands to help streamline development. In total, there are over 30 commands. Most may be regarded as implementation details of other commands, although each command could be used directly. Below, we discuss the commands that are most likely to be useful to you. For full details, consult the `package.json`.
Install the pinned versions of all package dependencies in all subprojects:
```console
$ yarn
```
Run backend and frontend in [production mode][8]:
```console
$ yarn start-p
```
Run the functional test suite:
```console
$ yarn test-func [FUNCTIONAL TEST OPTIONS]
```
The functional test suite by default assumes that you have the application running locally in production mode (i.e., on port `4200`). See [Configuring the browsers][10] and [Configuring the base address][11] in `functional-tests/README` for options.
[10]: functional-tests/README.md#configuring-the-browsers
[11]: functional-tests/README.md#configuring-the-base-address
Run _all_ tests (mostly useful for continuous integration):
```console
$ yarn test [FUNCTIONAL TEST OPTIONS]
```
Run an arbitrary command from within the root of a subproject:
```console
$ yarn back [ARBITRARY BACKEND COMMAND HERE]
$ yarn front [ARBITRARY FRONTEND COMMAND HERE]
$ yarn func [ARBITRARY FUNCTIONAL TESTS COMMAND HERE]
```
For example,
```console
$ yarn back less README.md
```
is equivalent to
```console
$ cd backend
$ less README.md
$ cd ..
```
Run `python manage.py` within the `backend` directory:
```console
$ yarn django [SUBCOMMAND] [OPTIONS]
```
`yarn django` is a shorthand for `yarn back python manage.py`. This command is useful for managing database migrations, among other things.
Manage the frontend package dependencies:
```console
$ yarn fyarn (add|remove|upgrade|...) (PACKAGE ...) [OPTIONS]
```
### Notes on Python package dependencies
Both the backend and the functional test suite are Python-based and package versions are pinned using [pip-tools][13] in both subprojects. For ease of development, you most likely want to use the same virtualenv for both and this is also what the `bootstrap.py` assumes.
[13]: https://pypi.org/project/pip-tools/
This comes with a small catch: the subprojects each have their own separate `requirements.txt`. If you run `pip-sync` in one subproject, the dependencies of the other will be uninstalled. In order to avoid this, you run `pip install -r requirements.txt` instead. The `yarn` command does this correctly by default.
Another thing to be aware of, is that `pip-compile` takes the old contents of your `requirements.txt` into account when building the new version based on your `requirements.in`. You can use the following trick to keep the requirements in both projects aligned so the versions of common packages don't conflict:
```console
$ yarn back pip-compile
# append contents of backend/requirements.txt to functional-tests/requirements.txt
$ yarn func pip-compile
```
### Development mode vs production mode
The purpose of development mode is to facilitate live development, as the name implies. The purpose of production mode is to simulate deployment conditions as closely as possible, in order to check whether everything still works under such conditions. A complete overview of the differences is given below.
| dimension | Development mode | Production mode |
| ----------------------------- | ------------------------------------------- | ------------------------------------------- |
| command | `yarn start` | `yarn start-p` |
| base address | http://localhost:8000 | http://localhost:4200 |
| backend server (Django) | in charge of everything | serves backend only |
| frontend server (angular-cli) | serves | watch and build |
| static files | served directly by Django's staticfiles app | collected by Django, served by gulp-connect |
| backend `DEBUG` setting | `True` | `False` |
| backend `ALLOWED_HOSTS` | - | restricted to `localhost` |
| frontend sourcemaps | yes | no |
| frontend optimization | no | yes |
## Deployment
Both the backend and frontend applications have a section dedicated to deployment in their own READMEs. You should read these sections entirely before proceeding. All instructions in these sections still apply, though it is good to know that you can use the following shorthand commands from the integrated project root:
```console
# collect static files of both backend and frontend, with overridden settings
$ yarn django collectstatic --settings SETTINGS --pythonpath path/to/SETTINGS.py
```
You should build the frontend before collecting all static files.