This repository has been archived by the owner on May 20, 2022. It is now read-only.
Refactor the module to reduce the technical debt and improve tournesol's distribution #11
Conversation
This file contains 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
Dynamically compute the percentage by rounding the given result rather than using a result matrix.
4383
changed the title
4383
changed the title
4383
commented
Sep 8, 2021
| FROM_TOP = 70 | ||
| LAST_N_DAYS = 120 | ||
|
|
||
| def get_top_percentage(criteria_row): |
There was a problem hiding this comment.
I completely refactored the function below to use math instead a result of matrix.
Please have a look to 3823c5d
This is why I wrote a sentence about gerrit vs github pull request in the description of this pull request.
4383
commented
Sep 8, 2021
| @@ -1,7 +1,7 @@ | |||
| import requests | |||
| import pandas as pd | |||
|
|
|||
| from data.utils_dict import YT_2_TWITTER, already_shared_filepath | |||
| from tournesolbot.data.utils_dict import YT_2_TWITTER, already_shared_filepath | |||
| @@ -242,7 +232,7 @@ def print_help(): | |||
| print("-t\ttweet the corresponding string (e.g. 'My tweet').\n") | |||
|
|
|||
|
|
|||
| if __name__ == '__main__': | |||
| def main(): | |||
There was a problem hiding this comment.
This is called by the entry points to launch the bot
| flake8-logging-format | ||
| commands = flake8 | ||
|
|
||
| [testenv:venv] |
There was a problem hiding this comment.
Allow us to run virtualenv by using tox:
tox -e venv -- virtualenv
| -r{toxinidir}/requirements.txt | ||
| commands = nosetests | ||
|
|
||
| [testenv:pep8] |
| envlist = py36,py37,py38,pep8 | ||
| ignore_basepython_conflict = true | ||
|
|
||
| [testenv] |
| [testenv:venv] | ||
| commands = {posargs} | ||
|
|
||
| [flake8] |
| from tournesolbot import get_top_percentage | ||
|
|
||
|
|
||
| class TestGetTopPercentage(unittest.TestCase): |
There was a problem hiding this comment.
Adding few unit test to test our math refactor.
This refactor allow us to:
- introduce entry points for a better CLI integration
- introduce unit tests
- introduce tox environment
- run unit tests
- run pep8 checks and linters
- start a virtualenv to interact with tournesolbot by using
`tox -e venv -- tournesolbot`. Useful for development session.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Hello,
This pull request is composed of two non squashed commits.
The first one aim to reduce the technical debt by using maths. It dynamically compute the percentage by rounding the given result rather than using a result matrix.
The second one aim to refactor a bit the tournesolbot module in global manner to allow us to introduce various features like:
tox -e venv -- tournesolbot)Now it will allow a better integration with pypi and will allow us to more merely distribute
tournesolbot.These 2 commits are independent unfortunately github pull request doesn't reflect well the git history like doing by gerrit.
Hopefully these changes will help you.