max-line-length = 120

select = C,E,F,W,B,B950

ignore = E501,W503,E203

.idea/

__pycache__/

*.py[cod]

dist/

*.egg-info/

build/

tests/tmp/*

!tests/tmp/.gitkeep

pip-wheel-metadata/

.pytest_cache/

variables:

PIP_CACHE_DIR: "${CI_PROJECT_DIR}/.cache/pip"

cache:

key: "${CI_JOB_NAME}"

paths:

- .cache/pip

- .venv

stages:

- quality

- tests

.install-deps-template: &install-deps

before_script:

- pip install poetry

- poetry --version

- poetry config settings.virtualenvs.in-project true

- poetry install -vv

.quality-template: &quality

<<: *install-deps

image: python:3.6

stage: quality

check-bandit:

<<: *quality

script: make check-bandit

check-black:

<<: *quality

script: make check-black

check-flake8:

<<: *quality

script: make check-flake8

check-isort:

<<: *quality

script: make check-isort

check-safety:

<<: *quality

script: make check-safety

.test-template: &test

<<: *install-deps

stage: tests

script: make test

python3.6:

<<: *test

image: python:3.6

python3.7:

<<: *test

image: python:3.7

python3.8:

<<: *test

image: python:3.8

3.6.8

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)

and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

In the interest of fostering an open and welcoming environment, we as

contributors and maintainers pledge to making participation in our project and

our community a harassment-free experience for everyone, regardless of age, body

size, disability, ethnicity, gender identity and expression, level of experience,

nationality, personal appearance, race, religion, or sexual identity and

orientation.

Examples of behavior that contributes to creating a positive environment

include:

* Using welcoming and inclusive language

* Being respectful of differing viewpoints and experiences

* Gracefully accepting constructive criticism

* Focusing on what is best for the community

* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or

advances

* Trolling, insulting/derogatory comments, and personal or political attacks

* Public or private harassment

* Publishing others' private information, such as a physical or electronic

address, without explicit permission

* Other conduct which could reasonably be considered inappropriate in a

professional setting

Project maintainers are responsible for clarifying the standards of acceptable

behavior and are expected to take appropriate and fair corrective action in

response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or

reject comments, commits, code, wiki edits, issues, and other contributions

that are not aligned to this Code of Conduct, or to ban temporarily or

permanently any contributor for other behaviors that they deem inappropriate,

threatening, offensive, or harmful.

This Code of Conduct applies both within project spaces and in public spaces

when an individual is representing the project or its community. Examples of

representing a project or community include using an official project e-mail

address, posting via an official social media account, or acting as an appointed

representative at an online or offline event. Representation of a project may be

further defined and clarified by project maintainers.

Instances of abusive, harassing, or otherwise unacceptable behavior may be

reported by contacting the project team at pawamoy@pm.me. All

complaints will be reviewed and investigated and will result in a response that

is deemed necessary and appropriate to the circumstances. The project team is

obligated to maintain confidentiality with regard to the reporter of an incident.

Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good

faith may face temporary or permanent repercussions as determined by other

members of the project's leadership.

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,

available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org

[version]: http://contributor-covenant.org/version/1/4/

Contributions are welcome, and they are greatly appreciated!

Every little bit helps, and credit will always be given.

For bug reports, feature requests, and feedback,

simply create a new [issue][1].

Try to be as descriptive as possible.

This project is developed using [`poetry`](https://github.com/sdispater/poetry).

Follow the recommended installation method:

curl -sSL https://raw.githubusercontent.com/sdispater/poetry/master/get-poetry.py | python

Then follow these instructions:

1. Fork the repository [on gitlab.com][2];

1. Clone it on your machine;

1. Go into the directory, and run `poetry install` to setup the development environment;

1. Create a new branch with `git checkout -b bug-fix-or-feature-name`;

1. Code!

1. **Write tests. Run them all.** The commands to run the tests are:

```bash

poetry run pytest # to run all tests sequentially

poetry run pytest -v # to print one test per line

poetry run pytest -n 4 # to run tests in parallel (4 workers)

poetry run pytest tests/test_api.py # to run tests in a specific file

```

`pytest` provides the `-k` option to select tests based on their names:

```bash

poetry run pytest -k "api and remove"

poetry run pytest -k "utils or stats"

```

See the [documentation for the `-k` option][3] for more examples.

A [Makefile](Makefile) is available for convenience: `make test`.

1. When the tests pass, commit

(make sure to have atomic commits and contextual commit messages!

[Check out this awesome blog post by Chris Beams for more information.][4])

1. Push;

1. ...and finally, create a new [pull/merge request][5]!

Make sure to follow the guidelines.

[1]: https://gitlab.com/pawamoy/mkdocstrings/issues/new

[2]: https://gitlab.com/pawamoy/mkdocstrings

[3]: https://docs.pytest.org/en/latest/example/markers.html#using-k-expr-to-select-tests-based-on-their-name

[5]: http://chris.beams.io/posts/git-commit/

[4]: https://gitlab.com/pawamoy/mkdocstrings/compare

ISC License

Copyright (c) 2019, Timothée Mazzucotelli

Permission to use, copy, modify, and/or distribute this software for any

purpose with or without fee is hereby granted, provided that the above

copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES

WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF

MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR

ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES

WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN

ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF

OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.