CONTRIBUTING.md

Contributing

Pull requests are always welcome. For major changes, please open an issue first to discuss what you would like to implement/change.

Set up the development environment

1. (Preferred) Install poetry.
2. Install development dependencies:

$ poetry install --with dev

Running tests

$ poetry run pytest

Running pre-commit

To install pre-commit hooks:

$ pre-commit install

Then you can run it manually:

$ pre-commit

Linting and formatting

Formatting your code with black:

$ black . --line-length 79

Linting with flake8:

$ poetry run flake8 . --max-doc-length 72 --show-source

Roadmap

Here's a table which illustrates current progress of endpoints implementation:

Endpoint	Implementation	Tests	Documentation
Account	In progress	In progress	In progress
Album	Done ✓	In progress	Not impl.
Comment	Done ✓	Done ✓	In progress
Feed	Not impl.	Not impl.	Not impl.
Gallery	Not impl.	Not impl.	Not impl.
Image	Done ✓	Done ✓	Done ✓
Memegen	Not impl.	Not impl.	Not impl.
Notification	Not impl.	Not impl.	Not impl.

Additionally, there are some preferable features that would be great to implement in the package:

• Method for bulk uploading images (e.g. from directory).
• Pagination with __next__() in some methods of Account endpoint.