Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/simonepri/text2error
〰 Introduce errors in error free text
https://github.com/simonepri/text2error
error generation grammatical-error-correction grammatical-error-detection text
Last synced: 12 days ago
JSON representation
〰 Introduce errors in error free text
- Host: GitHub
- URL: https://github.com/simonepri/text2error
- Owner: simonepri
- License: mit
- Created: 2020-03-31T09:22:25.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-06-04T10:27:01.000Z (over 4 years ago)
- Last Synced: 2024-10-22T16:11:08.013Z (2 months ago)
- Topics: error, generation, grammatical-error-correction, grammatical-error-detection, text
- Language: Python
- Size: 73.2 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
text2error
〰 Introduce errors in error free text
## Synopsis
Introduce errors in error free text.
## Development
You can install this library locally for development using the commands below.
If you don't have it already, you need to install [poetry](https://python-poetry.org/docs/#installation) first.
```bash
# Clone the repo
git clone https://github.com/simonepri/text2error
# CD into the created folder
cd text2error
# Create a virtualenv and install the required dependencies using poetry
poetry install
```
You can then run commands inside the virtualenv by using `poetry run COMMAND`.
Alternatively, you can open a shell inside the virtualenv using `poetry shell`.
If you wish to contribute to this project, run the following commands locally before opening a PR and check that no error is reported (warnings are fine).
```bash
# Run the code formatter
poetry run task format
# Run the linter
poetry run task lint
# Run the static type checker
poetry run task types
# Run the tests
poetry run task tests
```
## Authors
- **Simone Primarosa** - [simonepri][github:simonepri]
See also the list of [contributors][contributors] who participated in this project.
## License
This project is licensed under the MIT License - see the [license][license] file for details.
[start]: https://github.com/simonepri/text2error#start-of-content
[license]: https://github.com/simonepri/text2error/tree/master/license
[contributors]: https://github.com/simonepri/text2error/contributors
[github:simonepri]: https://github.com/simonepri