Pyta Template File Now Resolves Relative To Cwd

[DanielDervishi]

Proposed Changes

(Describe your changes here. Also describe the motivation for your changes: what problem do they solve, or how do they improve the application or codebase? If this pull request fixes an open issue, use a keyword to link this pull request to the issue.)

Problem: The path to the HTML Template file as specified by the argument pyta-template-file specified a file relative to the templates directory within the pythonTA project. We'd instead like for the pyta-template-file argument to specify the HTML template file to be used relative to the current working directory.

To achieve this, I changed how the template file path was processed in the HTML reporter to make it accept both relative and absolute paths. I also updated the documentation surrounding the pyta-tempate-file to explain that it is the path to the HTML template file. I also changed the default argument value for pyta-template-file to point to the absolute path of the default template.html.jinja file.

Type of Change

(Write an X or a brief description next to the type or types that best describe your changes.)

Type	Applies?
🚨 Breaking change (fix or feature that would cause existing functionality to change)	X
✨ New feature (non-breaking change that adds functionality)
🐛 Bug fix (non-breaking change that fixes an issue)
♻️ Refactoring (internal change to codebase, without changing functionality)
🚦 Test update (change that only adds or modifies tests)
📚 Documentation update (change that only updates documentation)
📦 Dependency update (change that updates a dependency)
🔧 Internal (change that only affects developers or continuous integration)

Checklist

(Complete each of the following items for your pull request. Indicate that you have completed an item by changing the [ ] into a [x] in the raw text, or by clicking on the checkbox in the rendered description on GitHub.)

Before opening your pull request:

• I have performed a self-review of my changes.
  • Check that all changed files included in this pull request are intentional changes.
  • Check that all changes are relevant to the purpose of this pull request, as described above.
• I have added tests for my changes, if applicable.
  • This is required for all bug fixes and new features.
• I have updated the project documentation, if applicable.
  • This is required for new features.
• I have updated the project Changelog (this is required for all changes).
• If this is my first contribution, I have added myself to the list of contributors.

After opening your pull request:

• I have verified that the pre-commit.ci checks have passed.
• I have verified that the CI tests have passed.
• I have reviewed the test coverage changes reported by Coveralls.
• I have requested a review from a project maintainer.

Questions and Comments

(Include any questions or comments you have regarding your changes.)

[david-yz-liu]

@DanielDervishi nice work, I just left one comment

[david-yz-liu]

It's not very common to have default values that are dynamically-set (in this case, based on the installation location for PythonTA). A more conventional approach is to use a default value like '', and then in the code which uses the value the dynamic TEMPLATES_DIR location is computed and the default template is used.

[coveralls]

Pull Request Test Coverage Report for Build 13221704166

Details

• 4 of 4 (100.0%) changed or added relevant lines in 1 file are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage increased (+0.006%) to 92.837%

---

Totals
Change from base Build 13221700645:	0.006%
Covered Lines:	3240
Relevant Lines:	3490

---

💛 - Coveralls

[david-yz-liu]

Nice work, @DanielDervishi!