diff --git a/README.md b/README.md index 3db48adc361d0c354ee5e2ad1738fc41a7df96df..7134006a7b1533798afa8db8697ed06f79fd2593 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ A python CLI to share data related to physical activities over an API (geo-local 1. Use services like [Strava](https://www.strava.com) to follow my physical activities (any other service is welcome) 1. Keep control over the data I share: just what I need ([_proportionality & relevance_](https://www.cnil.fr/fr/cnil-direct/question/quels-sont-les-grands-principes-des-regles-de-protection-des-donnees)) -1. Respect python guidelines proposed by _Vincent Bernat_ ( [🇫🇷](https://vincent.bernat.ch/fr/blog/2019-script-python-durable) | [🇬🇧](https://vincent.bernat.ch/en/blog/2019-sustainable-python-script) ). +1. Respect python scripting guidelines proposed by _Vincent Bernat_ ( [🇫🇷](https://vincent.bernat.ch/fr/blog/2019-script-python-durable) | [🇬🇧](https://vincent.bernat.ch/en/blog/2019-sustainable-python-script) ). ✨ (planed) Features @@ -24,12 +24,52 @@ These are imagined with _[Strava](https://developers.strava.com/docs/reference/) * [crop start, end & stop points](https://lab.frogg.it/fcode/geostrapy/-/issues/4) * [change start-time](https://lab.frogg.it/fcode/geostrapy/-/issues/5) * [Post GPX file as activity](https://lab.frogg.it/fcode/geostrapy/-/issues/6) -* [Process GPX multi-track file](7) +* [Process GPX multi-track file](https://lab.frogg.it/fcode/geostrapy/-/issues/7) * and [maybe more](https://lab.frogg.it/fcode/geostrapy/-/boards)… +🚀 (very) Quickstart +-------------------- + +```bash +git clone git@lab.frogg.it:fcode/geostrapy.git +cd geostrapy +echo "make --no-print-directory lint test" > .git/hooks/pre-commit +path/to/python3.9 -m venv ~/.venvs/geostrapy +source ~/.venvs/geostrapy/bin/activate +pip install -r requirements.txt +python geostrapy.py --help +``` + + +🚧 Development +-------------- + +- [Topic branches](https://git-scm.com/book/en/v2/Git-Branching-Branching-Workflows#_topic_branch) are used and named after issue's slug +- built with `Python 3.9` +- a `Makefile` with tools : run `make help` to have a look +- a `pre-commit` git hook is [available]() + + +### 📌 Dependences + +Details in [`requirements.txt`](requirements.txt) & [`requirements-dev.txt`](requirements-dev.txt) + +- [`requests`](https://requests.readthedocs.io) +- [`gpxpy`](https://github.com/tkrajina/gpxpy) + + +### ✅ Tests + +- tools : + * [`doctests`](https://docs.python.org/3/library/doctest.html) & [`pytest`](pytest.org/) : to get the job done + * [`vcrpy`](https://vcrpy.readthedocs.io/en/latest/) to record http requests +- run : various test commands are listed in `make help` + + ### 🤠Contributing +- Code linting with [`flake8`](), [`pylint`](), [``]() & [`black`]() - Roadmap âž¡ï¸ [_project kanban_](https://lab.frogg.it/fcode/geostrapy/-/boards) - Question, suggestion, issue âž¡ï¸ [_project issues_](https://lab.frogg.it/fcode/geostrapy/-/issues/new) - Code submission âž¡ï¸ [_project merge request_](https://lab.frogg.it/fcode/geostrapy/-/merge_requests/new) diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000000000000000000000000000000000000..130242922a854eb6b89d2a15ce6de18afeaef8c4 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,17 @@ +[flake8] +exclude = .venv +max-line-length = 90 + +[pylint] +ignore-patterns = tests*, .venv +output-format = colorized +score = n + +[tool:pytest] +addopts = --exitfirst +python_files = tests_*.py + +[coverage:run] +omit = + .venv/* + *__init__.py