Pypi: https://pypi.org/project/deutscher-befrager/
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.
Ask questions: $ befrager ask "Wo wohnen Sie?"
Answer questions: $ befrager answer
- 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/
- clone the repo
- cd into the folder
- create a python env for the project and install deps with
pipenv install
- run commands with
pipenv run python -m interviewer.core ask "Wie heißt du?"
- run unit tests with
pipenv run python -m unittest discover ./interviewer/ -v
- run test coverage with
pipenv run coverage run --source=./interviewer -m unittest discover ./interviewer
- view coverage report with
pipenv run coverage report
also possilbe to create html report see docs here
Currently the module is deployed locally to PyPi with the following steps:
- Before commiting remember to export requirements.txt and commit it:
$ pipenv run pip freeze > requirements.txt
- Start by tagging version:
$ git tag -a v0.0.2 -m 'version 0.0.2: Init PyPi capable package'
- clean from previous deploys:
rm -r dist
- build project:
python3 setup.py sdist bdist_wheel
- install built version locally to test:
pip3 install ./dist/deutscher-befrager-0.0.1.tar.gz
- push built files to PyPi:
python3 -m twine upload --repository-url https://test.pypi.org/legacy/ dist/*