fixing readme, added and got rid of some documentation#62
Merged
SethColeman50 merged 3 commits intomirrulations:mainfrom Apr 24, 2025
Merged
fixing readme, added and got rid of some documentation#62SethColeman50 merged 3 commits intomirrulations:mainfrom
SethColeman50 merged 3 commits intomirrulations:mainfrom
Conversation
SethColeman50
suggested changes
Apr 17, 2025
| - `pip install -r requirements.txt` | ||
| - cd to endpoints specifically and run `python -m pytest ../tests/handler_test.py` | ||
| - I do not know why the tests don't work in other directories, here's a [stackoverflow link](https://stackoverflow.com/questions/45154583/pytest-running-from-parent-directory) that might have the answers. | ||
| - cd to the root specifically and run `pylint --rcfile=./tests/.pylintrc $(git ls-files '*.py') |
Contributor
There was a problem hiding this comment.
I believe this runs linting and not the test, so I think both should stay in the readme
Contributor
Author
There was a problem hiding this comment.
Got it, I can also double check with @TeranG710
There was a problem hiding this comment.
@CloudUki Yes the command runs linting on every file ending in 'py' in the directory.
Contributor
Author
There was a problem hiding this comment.
@TeranG710 gotcha, ill add it back in then thank you.
dg25moravian
approved these changes
Apr 22, 2025
Contributor
dg25moravian
left a comment
dg25moravian
left a comment
There was a problem hiding this comment.
Changes look good to me
SethColeman50
approved these changes
Apr 23, 2025
Contributor
SethColeman50
left a comment
SethColeman50
left a comment
There was a problem hiding this comment.
Thanks for reincluding the test command, looks good!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Making this README unique to the API repo. Going to be adding more stuff soon.