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

LaTeX rendering and Web API #128

Closed

Conversation

nitroxide-poisoning
Copy link

Changed the following (at a high level):

  • Included a class that translates checklist into latex format
  • Included a Web API that runs on Flask which will run a local server and can be run on AWS
  • Instead of the default checklist given, changed the default to a directory containing 4 alterations with different languages and job titles
  • Included a new language flag that will render a checklist in a specified language if included in specified file
  • Included a jobs flag which can also specify a specific job
  • Created a file render, where if a file is specified as an input directory, it will render all files inside into HTML (to complement the Web API)

If any questions arise, feel free to contact me at any time.

  • Abinav Sadhneni

@pjbull
Copy link
Member

pjbull commented Apr 25, 2021

Hey @NitronBeenGrinding, thanks for the contributions!

Generally for contributions, especially of new features, we recommend opening an issue first for discussion of the feature and the implementation strategy that works best for integration and maintenance.

There are a few separate ideas here that should get their own separate issues (if one does not exist) and PRs for consideration:

  • Latex format (Suport LaTeX format #6)
  • Roles of "worker/boss" should get an issue for discussion to see if we can get consensus that a change like that makes sense.
  • Displaying IDs or not
  • We application (Web application for use and accountability #33). We wouldn't take the implementation in this PR. Instead of looking for files, it should actually generate the checklist using the deon package on POST, and the features that make it useful would would be to expose the YML, make it editable, and then generate the output formats interactively based on the user edited YML. What is in the PR is basically the "rendered verisons" that we already link to from deon.drivendata.org: https://github.com/drivendataorg/deon/tree/master/examples

Other smaller issues with the PR:

  • Includes *.pyc files that should not be in source control
  • Translations should use two-letter ISO languge codes + locale
  • Remove any untranslated versions (e.g., esp as submitted)
  • Remove output folder and generated ethics.md from the PR (already in examples)

Hopefully that's enough to split this up into issues and PRs that we can tackle independently. I'll close this one for now.

@pjbull pjbull closed this Apr 25, 2021
@nitroxide-poisoning
Copy link
Author

Alright, sounds good. I will make the changes in the coming weeks.

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

Successfully merging this pull request may close these issues.

2 participants