Imagecrawler pr0gramm (#185)

Author: jkowalleck

HISTORY.md

@@ -3,6 +3,15 @@
 
 ## Unreleased
 
+### Changes
+
+* class `ImageCrawlerInfo` lost support for positional arguments, supports keyword-arguments only - prepare future extensibility.
+* class `Image` lost support for positional arguments, supports keyword-arguments only - prepare future extensibility.
+
+### Added
+
+* added image crawler for [pr0gramm](https://pr0gramm.com) - Read the [docs](./docs/imagecrawlers/pr0gramm.md).
+
 
 ## 2.2.2
 

README.md

@@ -12,7 +12,8 @@
 
 _nichtparasoup_ is a hackspaces entertainment system.
 It randomly displays images from
-[instagram](https://instagram.com) and
+[instagram](https://instagram.com),
+[pr0gramm](https://pr0gramm.com) and
 [reddit](https://reddit.com).  
 Other crawlers are currently removed, but will be back soon.
 

docs/imagecrawlers/echo.md

@@ -9,7 +9,7 @@ More like an Parrot that is trained to repeat what you tell it to say.
 
 ## Config
 
-### `image_uri` 
+### `image_uri`
 
 - the URI to the image to show
 - type: string

docs/imagecrawlers/instagram_hashtag.md

@@ -6,7 +6,7 @@ A Crawler for hash tag posts of [https://www.instagram.com](https://www.instagra
 
 ## Config
 
-### `tag_name` 
+### `tag_name`
 
 - the HashTag on Instagram
 - type: string

docs/imagecrawlers/instagram_profile.md

@@ -6,7 +6,7 @@ A Crawler for profile pages of [https://www.instagram.com](https://www.instagram
 
 ## Config
 
-### `user_name` 
+### `user_name`
 
 - the UserName on Instagram
 - type: string

docs/imagecrawlers/picsum.md

@@ -7,12 +7,12 @@ Returns generic URIs to [https://picsum.photos](https://picsum.photos).
 
 ## Config
 
-### `with` 
+### `with`
 
 - the width of the image in pixels.
 - type: integer
 
-### `height` 
+### `height`
 
 - the height of the image in pixels.
 - type: integer

docs/imagecrawlers/pr0gramm.md

@@ -0,0 +1,22 @@
+# ImageCrawler: Pr0gramm
+
+## Purpose
+
+A Crawler for [https://pr0gramm.com](https://pr0gramm.com)
+
+
+## Config
+
+### `promoted`
+
+- Search only top("beliebt") voted content? Otherwise search anything("neu").
+- type: boolean
+- default: True
+- example: False
+
+### `tags`
+
+- None, or a string that starts with "!" - see the German [docs](https://pr0gramm.com/new/2782197).
+- type: None or string
+- default: None
+- example: '!s:500 kadse -text'

docs/imagecrawlers/reddit.md

@@ -7,7 +7,7 @@ A Crawler for an arbitrary SubReddit of [https://www.reddit.com](https://www.red
 
 ## Config
 
-### `subreddit` 
+### `subreddit`
 
 - the SubReddit to crawl
 - type: string

examples/config/kadsen.yaml

@@ -0,0 +1,15 @@
+## This is a config file for nichtprasoup (v2.3)
+## This is an example file. For a better kickStart run: nichtparasoup config --help
+
+webserver:
+  hostname: "0.0.0.0"
+  port: 8080
+
+imageserver:
+  crawler_upkeep: 10
+
+crawlers:
+  - name: "Pr0gramm"
+    config:
+      tags: '!s:500 kadse -text'
+      promoted: True

nichtparasoup/core/image.py

@@ -49,7 +49,8 @@ class Image(object):
 
     """
 
-    def __init__(self, uri: ImageUri, source: SourceUri,
+    def __init__(self, *,
+                 uri: ImageUri, source: SourceUri,
                  is_generic: bool = False,
                  **more: Any) -> None:  # pragma: no cover
         self.uri = uri