Skip to content

Commit e5a6a7b

Browse files
committedJan 28, 2023
updates changelog and readme
1 parent 42e7cdc commit e5a6a7b

File tree

3 files changed

+23
-2
lines changed

3 files changed

+23
-2
lines changed
 

‎CHANGELOG.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [Unreleased]
99

10+
## [0.2.0] - 2023-01-28
11+
1012
### Added
1113

1214
* Import script that allows importing exercises into the repo without cloning it or running any scripts.
1315
* Second variant of `suggest_tags` that uses a list of predefined tag candidates.
16+
* Script to automatically translate exercise text into another (natural) language.
17+
* Basic Python API tracked as Poetry project.
1418

1519
## [0.1.0] - 2022-01-06
1620

@@ -92,7 +96,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
9296
- Objektorientierte Programmierung (BI Master) 2015
9397
- Girl's Day 2019 (full)
9498

95-
[Unreleased]: https://github.com/cschoel/exercise-heap/compare/v0.1.0...HEAD
99+
[Unreleased]: https://github.com/cschoel/exercise-heap/compare/v0.2.0...HEAD
100+
[0.2.0]: https://github.com/cschoel/exercise-heap/compare/v0.1.0...v0.2.0
96101
[0.1.0]: https://github.com/cschoel/exercise-heap/compare/v0.0.3...v0.0.4
97102
[0.0.4]: https://github.com/cschoel/exercise-heap/compare/v0.0.3...v0.0.4
98103
[0.0.3]: https://github.com/cschoel/exercise-heap/compare/v0.0.2...v0.0.3

‎README.md

+16
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,17 @@ keywords:
103103
104104
## Existing scripting functionality
105105
106+
### Python API
107+
108+
There is a Python API that collects general functionality that can be useful in multiple scripts.
109+
It can be found in the `python_api` folder and is tracked as a [Poetry](https://python-poetry.org/) project.
110+
You can install it with `poetry install` or `pip install .`.
111+
112+
The API contains the following modules:
113+
114+
* `exercise_heap.header`: All code interacting with YAML headers.
115+
* `exercise_heap.description`: All code interacting with markdown-formatted description texts.
116+
106117
### Import
107118

108119
Import is currently possible with the following scripts:
@@ -123,6 +134,11 @@ Import is currently possible with the following scripts:
123134
* `create_tagnames.py`: Creates list of tag names from Stack Exchange Data Dump.
124135
* `suggest_tags.py`: Suggests which tags to add or remove for a newly added exercise (based on lists generated by `create_tagnames.py` and a simple nearest-neighbor search).
125136

137+
138+
### Translation
139+
140+
* `translate_exercise_text.py`: Translates title and text description of one or multiple exercises into a given target language using neural machine translation.
141+
126142
## General notes
127143

128144
### Source code

‎pyproject.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "exercise-heap"
3-
version = "0.1.0"
3+
version = "0.2.0"
44
description = "API for interacting with files stored in the exercise heap."
55
authors = ["Christopher Schölzel <christopher.schoelzel@mailbox.org>"]
66
license = "MIT"

0 commit comments

Comments
 (0)
Please sign in to comment.