BTBTravis / Deutscher-Befrager

German language learning cli tool. Ask questions, answer questions, and grade responses.

Deutscher Befrager

Pypi: https://pypi.org/project/deutscher-befrager/

Purpose

I'm in the process of learning german but I don't work in german so I made this as a way to practice while I'm on the command line.

Usage

Ask questions: $ befrager ask "Wo wohnen Sie?"

Answer questions: $ befrager answer

Dev

Useful links

• click docs: https://click.palletsprojects.com/en/7.x/quickstart/
• yaml docs: https://pyyaml.org/wiki/PyYAMLDocumentation
• yaml lang docs: https://yaml.org/
• yaml loader info: https://github.com/yaml/pyyaml/wiki/PyYAML-yaml.load(input)-Deprecation
• unittest: https://docs.python.org/2/library/unittest.html
• guide to unittest: https://realpython.com/python-testing/
• packaging docs: https://packaging.python.org/tutorials/packaging-projects/

Local dev

1. clone the repo
2. cd into the folder
3. create a python env for the project and install deps with pipenv install
4. run commands with pipenv run python -m interviewer.core ask "Wie heißt du?"
5. run unit tests with pipenv run python -m unittest discover ./interviewer/ -v
6. run test coverage with pipenv run coverage run --source=./interviewer -m unittest discover ./interviewer
7. view coverage report with pipenv run coverage report also possilbe to create html report see docs here

Deployment

Currently the module is deployed locally to PyPi with the following steps:

1. Before commiting remember to export requirements.txt and commit it: $ pipenv run pip freeze > requirements.txt
2. Start by tagging version: $ git tag -a v0.0.2 -m 'version 0.0.2: Init PyPi capable package'
3. clean from previous deploys: rm -r dist
4. build project: python3 setup.py sdist bdist_wheel
5. install built version locally to test: pip3 install ./dist/deutscher-befrager-0.0.1.tar.gz
6. push built files to PyPi: python3 -m twine upload --repository-url https://test.pypi.org/legacy/ dist/*