diff --git a/.coveragerc b/.coveragerc new file mode 100644 index 0000000..2890b53 --- /dev/null +++ b/.coveragerc @@ -0,0 +1,29 @@ +# .coveragerc to control coverage.py +[run] +branch = True +source = fuelpricetracker +# omit = bad_file.py + +[paths] +source = + src/ + */site-packages/ + +[report] +# Regexes for lines to exclude from consideration +exclude_lines = + # Have to re-enable the standard pragma + pragma: no cover + + # Don't complain about missing debug-only code: + def __repr__ + if self\.debug + + # Don't complain if tests don't hit defensive assertion code: + raise AssertionError + raise NotImplementedError + + # Don't complain if non-runnable code isn't run: + if 0: + if __name__ == .__main__.: + diff --git a/README.rst b/README.rst index 4fe45cd..4e823cd 100644 --- a/README.rst +++ b/README.rst @@ -1,30 +1,19 @@ ================== -fuel_price_tracker +Fuel Price Tracker ================== +Fuel provider seeker software. Based on French Government data (data.gouv.fr), user is able to sort by price cheapest fuel provider surrounding its area in a given radius. -Tool for sorting gas price according to a given French departement number - - -Description -=========== - -A longer description of your project goes here... - - -Note -==== - -TODO : - -- Enhance the output display -- Integrating ot to a a Telegram Bot to leverage (longitude,latitude) given data. - -How to Use (example) from .src/fuel_price_tracker : - - python3 parsing.py --dept 86 --gas E10 - - Will return you a list of sorted dict of all gas stations of the 86 (Vienne) for SP95-E10. - +================== +How-to +================== + +```python +python3 parsing.py --dept 75 --gas E10 + +```` +will the GPS adress of the cheapest E10 provider in Paris. + +This app has been extended with a mobile support developed with Flutter, a beta will be release soon.