Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Auto-generate materials #3

Open
llorracc opened this issue Mar 27, 2020 · 1 comment
Open

Auto-generate materials #3

llorracc opened this issue Mar 27, 2020 · 1 comment
Assignees
Labels
enhancement New feature or request

Comments

@llorracc
Copy link
Contributor

We should move toward a system where there is a script that gets run automatically which:

  1. Checks whether there are items in REMARK/REMARKs, DemARK/notebooks, or QuARK/notebooks or HARK/examples for which no materials.md file exists
  2. Attempts to automatically construct the stub of a materials.md file that will work if some minimal amount of content exists where it should be.
    • We can start with the minimal content simply being the existence of an eponymous Jupyter notebook
    • Later we might add some other requirements
  3. Keeps tabs of the content for which the materials.md file has been autogenerated.
    • Along with a list of things that ought to be done to make it into a first-class materials entry
@llorracc llorracc added the enhancement New feature or request label Mar 27, 2020
@DrDrij
Copy link
Member

DrDrij commented Jan 31, 2024

Hi @llorracc , I have just written a little response below to my interpretation of this issue. I am wondering if such a tool would be useful? (I realise this is an old issue so maybe no longer pertinent)

GenARK

image

Proposal for a Command-Line Econ-ARK material creation tool. When a user launches the tool, it collects user input to create a metadata file and uploads the metadata stub along with the notebook file to the correct repository.
Further - the tool could be used to open existing materials and quickly edit metadata or assets.
The tool will always check for minimum number of required metadata and check formats are correct.

  • Econ-ARK Material Generator Tool (GenARK)
  • Command line interface
  • Python
  • User input foreach metadata value
  • Check whether material title already exists (REMARK, DemARK, QuARK, HARK
  • Creates metadata files from values collected
  • Asks for local file path to notebook file/assets
  • User is presented metadata to review/edit/add values
  • Upload metadata file and notebook/assets to appropriate repository
  • Initiate econ-ark.org rebuild with new material metadata stub
  • Present user with econ-ark.org URL for the new material

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants