update textfile scheleton, todo added

This commit is contained in:
SebastianoF 2019-11-21 22:44:23 +00:00
parent 75854930af
commit 44ed8577b3
2 changed files with 36 additions and 0 deletions

14
TODO.txt Normal file
View File

@ -0,0 +1,14 @@
v get a single python file with all questions, hints and answers in a single dictionary.
v implement 3 functions: question, hint and solution, printing the required question, hint and solution in an `initialise.py` file.
+ produce one jupyter with all the questions, the initialise.py in the first cell creating the full notebook: numpy_100_consecutive.ipynb
+ produce one jupyter notebook with the random game. initialise must also have a pick() function to get a random question: numpy_100_random.ipynb.
+ produce the method to create the md files (questions, questions with hints, questions with solutions, questions with hints and solution)
+ add to this method the a cli interface for quick manipulation.
+ produce and leave the files created with the cli.
+ cleanup. Erase all the other notebook but the two new 2 jupyter notebooks - numpy_100_consecutive.ipynb numpy_100_random.ipynb.
+ change the instructions in the readme to create the markdown files with hints with hints and answers and with only questions.
+ send PR.
Utilities:
https://stackoverflow.com/questions/13614783/programmatically-add-cells-to-an-ipython-notebook-for-report-generation

22
update_textfile.py Normal file
View File

@ -0,0 +1,22 @@
"""
Module to automatically create the 100 exercises (with or without hints and answers)
as a textfile format (markdown format).
"""
from .questsions_dict import qha
HEADER = "DO NOT MODIFY. \nFile automatically created. To modify change the content of questions_dict.py and then" \
"re create via the python script 'create_as_textfile.py'. Search the documentation for more info."
def to_markdown(destination_filename, with_ints=False, with_answers=False):
pass
def to_rst(destination_filename, with_ints=False, with_answers=False):
pass
def cli():
pass