<img src="https://github.com/AnneliesVlaar/Feat/blob/main/src/feat/resources/FT-logo128.jpg?raw=true" alt="FEAT Logo" width="80" height="80">
# Feat
Feedback Experiment Aansturing Tool
Create fast feedback messages based on your own prewritten feedback file and add personalised feedback per student. Feat requires you to import a list of student, which allows you to create feedback messages with personal salutation. It also gives you the opportunity to easily switch between the feedback text for all students in your group. You can save the .feat file and continue to provide feedback. With a single click the feedback messages is copied to your clipboard and ready to send to your students using the communication method of your choice.
## Features
* Import prewritten feedback
* Import student names
* Switch between feedback messages of students
* Have personal salutations
* Add personalised feedback for each feedback section
* Add personalised feedback in a general section
* Add general complimentary close
* Save the feedback messages
* Copy the feedback messages to the clipboard
## Screenshots
Select **file > new**, a new window appears.
* Select the location to save the .feat file and give it a name.
* Select the file with student names.
* select the file with feedback.
Click create to create the .feat file and start composing feedback.
Select **file > open** to open a .feat file.
## File Format Specifications
### Student file
The file(.txt) with student names should be designed in the following way:
```
# Teaching assistant (information)
first_name lastname (unique_student_id)
first_name lastname (unique_student_id)
```
Text after '#' can be arbitrary since lines with '#' will be skipped. First names with spaces must be connected with "_".
There is an [example student file](https://github.com/AnneliesVlaar/Feat/blob/main/teststudenten.txt) available.
### Feedback form
The file(.toml) with feedback should be designed in the following way:
```
["Section 1"]
Unique_id = "Feedbackline 1"
Unique_id = "Feedbackline 2"
Unique_id = "Feedbackline 3"
Unique_id = "Feedbackline 4"
["Section 2"]
Unique_id = "Feedbackline 1"
Unique_id = "Feedbackline 2"
Unique_id = "Feedbackline 3"
Unique_id = "Feedbackline 4"
```
The unique IDs must be unique within the feedback form.
There is an [example feedback form](https://github.com/AnneliesVlaar/Feat/blob/main/feedbackpunten.toml) available.
## Install
In a virtual environment:
```
pip install feat-feedback-tool
```
Or with pipx:
```
pipx install feat-feedback-tool
```
Open Feat with ft.
```
ft.
```
### Development instructions
Clone the repository
Create a new conda environment with python
```
conda create -n feat python
```
Activate the new conda enviornment
```
conda activate feat
```
Install Feat with poetry install
```
poetry install
```
Open Feat with ft.
```
ft.
```
Raw data
{
"_id": null,
"home_page": "https://github.com/AnneliesVlaar/Feat",
"name": "feat-feedback-tool",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": "AnneliesVlaar",
"author_email": "66774020+AnneliesVlaar@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/8d/cf/2265836e1f92b66f52f47308416dc215ee36be0e2a688f737854e496a0fd/feat_feedback_tool-0.4.1.tar.gz",
"platform": null,
"description": "<img src=\"https://github.com/AnneliesVlaar/Feat/blob/main/src/feat/resources/FT-logo128.jpg?raw=true\" alt=\"FEAT Logo\" width=\"80\" height=\"80\">\n\n# Feat\nFeedback Experiment Aansturing Tool\n\nCreate fast feedback messages based on your own prewritten feedback file and add personalised feedback per student. Feat requires you to import a list of student, which allows you to create feedback messages with personal salutation. It also gives you the opportunity to easily switch between the feedback text for all students in your group. You can save the .feat file and continue to provide feedback. With a single click the feedback messages is copied to your clipboard and ready to send to your students using the communication method of your choice. \n\n## Features\n* Import prewritten feedback\n* Import student names\n* Switch between feedback messages of students\n* Have personal salutations\n* Add personalised feedback for each feedback section\n* Add personalised feedback in a general section\n* Add general complimentary close\n* Save the feedback messages\n* Copy the feedback messages to the clipboard\n\n## Screenshots\nSelect **file > new**, a new window appears. \n\n\n\n* Select the location to save the .feat file and give it a name.\n* Select the file with student names.\n* select the file with feedback.\n\nClick create to create the .feat file and start composing feedback. \n\nSelect **file > open** to open a .feat file. \n\n\n\n## File Format Specifications\n### Student file\nThe file(.txt) with student names should be designed in the following way:\n```\n# Teaching assistant (information)\nfirst_name lastname (unique_student_id)\nfirst_name lastname (unique_student_id)\n```\nText after '#' can be arbitrary since lines with '#' will be skipped. First names with spaces must be connected with \"_\".\nThere is an [example student file](https://github.com/AnneliesVlaar/Feat/blob/main/teststudenten.txt) available. \n\n### Feedback form\nThe file(.toml) with feedback should be designed in the following way:\n```\n[\"Section 1\"]\nUnique_id = \"Feedbackline 1\"\nUnique_id = \"Feedbackline 2\"\nUnique_id = \"Feedbackline 3\" \nUnique_id = \"Feedbackline 4\"\n\n[\"Section 2\"]\nUnique_id = \"Feedbackline 1\"\nUnique_id = \"Feedbackline 2\"\nUnique_id = \"Feedbackline 3\"\nUnique_id = \"Feedbackline 4\"\n\n```\nThe unique IDs must be unique within the feedback form.\nThere is an [example feedback form](https://github.com/AnneliesVlaar/Feat/blob/main/feedbackpunten.toml) available. \n\n## Install\nIn a virtual environment:\n```\npip install feat-feedback-tool\n```\n\nOr with pipx:\n```\npipx install feat-feedback-tool\n```\n\nOpen Feat with ft. \n```\nft.\n```\n\n### Development instructions\nClone the repository\n\nCreate a new conda environment with python\n```\nconda create -n feat python\n``` \nActivate the new conda enviornment\n```\nconda activate feat\n```\nInstall Feat with poetry install\n```\npoetry install\n```\nOpen Feat with ft. \n```\nft.\n```",
"bugtrack_url": null,
"license": "CC-BY-NC-SA-2.5",
"summary": "Create fast feedback based on prewritten sentences combined with personalised messages.",
"version": "0.4.1",
"project_urls": {
"Homepage": "https://github.com/AnneliesVlaar/Feat",
"Repository": "https://github.com/AnneliesVlaar/Feat"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d2ae8570641c307ba0f7d3d26a48877a5df110367ef843606bba28c03d140dad",
"md5": "36420e5e532808f61c5cc63e43855a68",
"sha256": "0db9ad9a98260a037d152c1337b2c2d439f1ac5fea93f966017d4f1fafae7e7d"
},
"downloads": -1,
"filename": "feat_feedback_tool-0.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "36420e5e532808f61c5cc63e43855a68",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.10",
"size": 124451,
"upload_time": "2024-08-05T13:21:51",
"upload_time_iso_8601": "2024-08-05T13:21:51.254064Z",
"url": "https://files.pythonhosted.org/packages/d2/ae/8570641c307ba0f7d3d26a48877a5df110367ef843606bba28c03d140dad/feat_feedback_tool-0.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8dcf2265836e1f92b66f52f47308416dc215ee36be0e2a688f737854e496a0fd",
"md5": "06787dc4ab5df0e6bd0755e197be5117",
"sha256": "134774def6bc72e47691fe83a96c8d8312e18fd2d48de7917c4944a1e4f77fd2"
},
"downloads": -1,
"filename": "feat_feedback_tool-0.4.1.tar.gz",
"has_sig": false,
"md5_digest": "06787dc4ab5df0e6bd0755e197be5117",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.10",
"size": 124838,
"upload_time": "2024-08-05T13:21:53",
"upload_time_iso_8601": "2024-08-05T13:21:53.034771Z",
"url": "https://files.pythonhosted.org/packages/8d/cf/2265836e1f92b66f52f47308416dc215ee36be0e2a688f737854e496a0fd/feat_feedback_tool-0.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-05 13:21:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "AnneliesVlaar",
"github_project": "Feat",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "feat-feedback-tool"
}
JSON
