adding initial movieposterporndownloader

plex-posters/README.rst

@@ -1,4 +1,15 @@
 plex_posters
 ============
 
+.. image:: https://img.shields.io/readthedocs/plex-posters?style=for-the-badge   :target: https://plex-posters.readthedocs.io/en/latest/?badge=latest
+   :alt: Documentation Status
+
+.. image:: https://img.shields.io/github/v/tag/dtomlinson91/plex_posters?style=for-the-badge   :alt: GitHub tag (latest by date)
+
+.. image:: https://img.shields.io/github/commit-activity/m/dtomlinson91/plex_posters?style=for-the-badge   :alt: GitHub commit activity
+
+.. image:: https://img.shields.io/github/issues/dtomlinson91/plex_posters?style=for-the-badge   :alt: GitHub issues
+
+.. image:: https://img.shields.io/github/license/dtomlinson91/plex_posters?style=for-the-badge   :alt: GitHub
+
 A script to pull the top 10 hottest posters from /r/moviepostersporn

plex-posters/docs/source/_static/custom.css

@@ -16,16 +16,72 @@
     border-left: 2px solid #ddd;
 }
 
+/*colour of the text in the toc*/
 .wy-menu-vertical header, .wy-menu-vertical p.caption{
-    color: ##466A54;;
+    color: #b26d46;;
 }
 
+/*colour of the top left header*/
 .wy-side-nav-search{
-    background-color: #0E6458;
+    background-color: #31465a;
 }
 
+/*colours of the class definitions*/
 .rst-content dl:not(.docutils) dt{
-    background: #F2E7D3;
-    color: #499265;
-    border-top: solid 3px #87CB7C;
+    background: #e2d7d1;
+    color: #0b2852;
+    border-top: solid 3px #31465a;
+}
+
+/*colour of the link in the class defintions*/
+.rst-content .viewcode-link, .rst-content .viewcode-back{
+    color: #4b674a;
+}
+
+/*colour of the function definitions*/
+.rst-content dl:not(.docutils) dl dt{
+    border-left: solid 3px #31465a;
+    background: #e2d7d1;
+    color: #0b2852;
+}
+
+/*colour of the link in the function definitions*/
+.rst-content .viewcode-link, .rst-content .viewcode-back{
+    color: #4b674a;
+}
+
+/*edit the width of the body*/
+.wy-nav-content{
+    max-width: 1200px;
+}
+
+/*code example blocks*/
+.rst-content pre.literal-block, .rst-content div[class^="highlight"] pre, .rst-content .linenodiv pre{
+    background: #b4bec8;
+    color: black;
+    /*border-style: solid;*/
+    /*border-width: thin;*/
+}
+
+/*colour of inline code blocks using ``*/
+.rst-content tt.literal, .rst-content tt.literal, .rst-content code.literal{
+    color: #b26d46;
+}
+
+/* Change code blocks font and bump up font size slightly (normally 12px)*/
+.rst-content pre.literal-block, .rst-content div[class^="highlight"] pre, .rst-content .linenodiv pre {
+    font-family: 'Inconsolata', monospace !important;
+    font-size: 14px !important;
+    white-space: pre-wrap;
+}
+
+/* Change code descriptions and literal blocks (inline code via ``) to match the normal font size being used in the sphinx_RTD_theme text  (normally 14px)*/
+.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) tt.descclassname,.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) code.descname,.rst-content dl:not(.docutils) tt.descclassname,.rst-content dl:not(.docutils) code.descclassname, code.docutils {
+    font-family: 'Inconsolata', monospace !important;
+    font-size: 14px !important;
+}
+
+/*variables text*/
+dl.class > dd > table.docutils.field-list tbody tr.field-odd.field th.field-name::before{
+    content: '(Class Attributes) ';
 }

plex-posters/docs/source/changelog.rst

@@ -1,6 +1,16 @@
 Version history
 ================
 
+0.3.0 (29/11/19)
+----------------
+
+- Adding badges to documentation
+
+0.2.0 (28/11/19)
+----------------
+
+- Updating documentation
+
 0.1.0 (28/11/19)
 ----------------
 

plex-posters/docs/source/conf.py

@@ -84,6 +84,7 @@ html_context = {'css_files': ['_static/custom.css']}
 html_theme_options = {
     'collapse_navigation': True,
     'display_version': True,
+    'prev_next_buttons_location': 'both',
     #'navigation_depth': 3,
 }
 

plex-posters/docs/source/modules/plex_posters.lib.rst

@@ -1,9 +0,0 @@
-.. include:: ../global.rst
-
-Lib :modname:`plex_posters.lib`
-------------------------------------
-
-.. automodule:: plex_posters.lib
-   :members:
-   :undoc-members:
-   :show-inheritance:

plex-posters/docs/source/modules/plex_posters.library.rst

@@ -0,0 +1,9 @@
+.. include:: ../global.rst
+
+Library :modname:`plex_posters.library`
+----------------------------------------
+
+.. automodule:: plex_posters.library
+   :members:
+   :undoc-members:
+   :show-inheritance:

plex-posters/docs/source/modules/plex_posters.rst

@@ -14,4 +14,4 @@ Subpackages
 .. toctree::
 
    plex_posters.config
-   plex_posters.lib
+   plex_posters.library

plex-posters/docs/source/toc.rst

@@ -20,5 +20,5 @@
    :titlesonly:
 
    modules/plex_posters.config.config.rst
-   modules/plex_posters.lib.rst
+   modules/plex_posters.library.rst
 

plex-posters/poetry.lock

@@ -55,6 +55,18 @@ optional = false
 python-versions = "*"
 version = "3.0.4"
 
+[[package]]
+category = "dev"
+description = "Hosted coverage reports for Github, Bitbucket and Gitlab"
+name = "codecov"
+optional = false
+python-versions = "*"
+version = "2.0.15"
+
+[package.dependencies]
+coverage = "*"
+requests = ">=2.7.9"
+
 [[package]]
 category = "dev"
 description = "Cross-platform colored terminal text."
@@ -64,6 +76,14 @@ optional = false
 python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*"
 version = "0.4.1"
 
+[[package]]
+category = "dev"
+description = "Code coverage measurement for Python"
+name = "coverage"
+optional = false
+python-versions = ">=2.6, !=3.0.*, !=3.1.*, !=3.2.*, <4"
+version = "4.5.4"
+
 [[package]]
 category = "dev"
 description = "Docutils -- Python Documentation Utilities"
@@ -464,7 +484,7 @@ version = "0.56.0"
 six = "*"
 
 [metadata]
-content-hash = "8f2035c47db0ff77df15941d995000a73e7873006e556bbbd0a7de4f0a9620e3"
+content-hash = "527ff28e922eed13e4af85daf7c1338fb63206646e93501199e32fd949ddbe71"
 python-versions = "^3.8"
 
 [metadata.hashes]
@@ -474,7 +494,9 @@ attrs = ["08a96c641c3a74e44eb59afb61a24f2cb9f4d7188748e76ba4bb5edfa3cb7d1c", "f7
 babel = ["af92e6106cb7c55286b25b38ad7695f8b4efb36a90ba483d7f7a6628c46158ab", "e86135ae101e31e2c8ec20a4e0c5220f4eed12487d5cf3f78be7e98d3a57fc28"]
 certifi = ["e4f3620cfea4f83eedc95b24abd9cd56f3c4b146dd0177e83a21b4eb49e21e50", "fd7c7c74727ddcf00e9acd26bba8da604ffec95bf1c2144e67aff7a8b50e6cef"]
 chardet = ["84ab92ed1c4d4f16916e05906b6b75a6c0fb5db821cc65e70cbd64a3e2a5eaae", "fc323ffcaeaed0e0a02bf4d117757b98aed530d9ed4531e3e15460124c106691"]
+codecov = ["8ed8b7c6791010d359baed66f84f061bba5bd41174bf324c31311e8737602788", "ae00d68e18d8a20e9c3288ba3875ae03db3a8e892115bf9b83ef20507732bed4"]
 colorama = ["05eed71e2e327246ad6b38c540c4a3117230b19679b875190486ddd2d721422d", "f8ac84de7840f5b9c4e3347b3c1eaa50f7e49c2b07596221daec5edaabbd7c48"]
+coverage = ["08907593569fe59baca0bf152c43f3863201efb6113ecb38ce7e97ce339805a6", "0be0f1ed45fc0c185cfd4ecc19a1d6532d72f86a2bac9de7e24541febad72650", "141f08ed3c4b1847015e2cd62ec06d35e67a3ac185c26f7635f4406b90afa9c5", "19e4df788a0581238e9390c85a7a09af39c7b539b29f25c89209e6c3e371270d", "23cc09ed395b03424d1ae30dcc292615c1372bfba7141eb85e11e50efaa6b351", "245388cda02af78276b479f299bbf3783ef0a6a6273037d7c60dc73b8d8d7755", "331cb5115673a20fb131dadd22f5bcaf7677ef758741312bee4937d71a14b2ef", "386e2e4090f0bc5df274e720105c342263423e77ee8826002dcffe0c9533dbca", "3a794ce50daee01c74a494919d5ebdc23d58873747fa0e288318728533a3e1ca", "60851187677b24c6085248f0a0b9b98d49cba7ecc7ec60ba6b9d2e5574ac1ee9", "63a9a5fc43b58735f65ed63d2cf43508f462dc49857da70b8980ad78d41d52fc", "6b62544bb68106e3f00b21c8930e83e584fdca005d4fffd29bb39fb3ffa03cb5", "6ba744056423ef8d450cf627289166da65903885272055fb4b5e113137cfa14f", "7494b0b0274c5072bddbfd5b4a6c6f18fbbe1ab1d22a41e99cd2d00c8f96ecfe", "826f32b9547c8091679ff292a82aca9c7b9650f9fda3e2ca6bf2ac905b7ce888", "93715dffbcd0678057f947f496484e906bf9509f5c1c38fc9ba3922893cda5f5", "9a334d6c83dfeadae576b4d633a71620d40d1c379129d587faa42ee3e2a85cce", "af7ed8a8aa6957aac47b4268631fa1df984643f07ef00acd374e456364b373f5", "bf0a7aed7f5521c7ca67febd57db473af4762b9622254291fbcbb8cd0ba5e33e", "bf1ef9eb901113a9805287e090452c05547578eaab1b62e4ad456fcc049a9b7e", "c0afd27bc0e307a1ffc04ca5ec010a290e49e3afbe841c5cafc5c5a80ecd81c9", "dd579709a87092c6dbee09d1b7cfa81831040705ffa12a1b248935274aee0437", "df6712284b2e44a065097846488f66840445eb987eb81b3cc6e4149e7b6982e1", "e07d9f1a23e9e93ab5c62902833bf3e4b1f65502927379148b6622686223125c", "e2ede7c1d45e65e209d6093b762e98e8318ddeff95317d07a27a2140b80cfd24", "e4ef9c164eb55123c62411f5936b5c2e521b12356037b6e1c2617cef45523d47", "eca2b7343524e7ba246cab8ff00cab47a2d6d54ada3b02772e908a45675722e2", "eee64c616adeff7db37cc37da4180a3a5b6177f5c46b187894e633f088fb5b28", "ef824cad1f980d27f26166f86856efe11eff9912c4fed97d3804820d43fa550c", "efc89291bd5a08855829a3c522df16d856455297cf35ae827a37edac45f466a7", "fa964bae817babece5aa2e8c1af841bebb6d0b9add8e637548809d040443fee0", "ff37757e068ae606659c28c3bd0d923f9d29a85de79bf25b2b34b148473b5025"]
 docutils = ["6c4f696463b79f1fb8ba0c594b63840ebd41f059e92b31957c46b74a4599b6d0", "9e4d7ecfc600058e07ba661411a2b7de2fd0fafa17d1a7f7361cd47b1175c827", "a2aeea129088da402665e92e0b25b04b073c04b2dce4ab65caaa38b7ce2e1a99"]
 idna = ["c357b3f628cf53ae2c4c05627ecc484553142ca23264e593d327bcde5e9c3407", "ea8b7f6188e6fa117537c3df7da9fc686d485087abf6ac197f9c46432f7e4a3c"]
 imagesize = ["3f349de3eb99145973fefb7dbe38554414e5c30abd0c8e4b970a7c9d09f3a1d8", "f3832918bc3c66617f92e35f5d70729187676313caa60c187eb0f28b8fe5e3b5"]

plex-posters/pyproject.toml

@@ -15,6 +15,7 @@ mypy = "^0.740.0"
 pudb = "^2019.2"
 sphinx = "^2.2"
 sphinx_rtd_theme = "^0.4.3"
+codecov = "^2.0"
 
 [build-system]
 requires = ["poetry>=0.12"]

plex-posters/setup.py

@@ -8,7 +8,7 @@ packages = \
 ['plex_posters',
  'plex_posters.__dev',
  'plex_posters.config',
- 'plex_posters.lib']
+ 'plex_posters.library']
 
 package_data = \
 {'': ['*'],

plex-posters/src/plex_posters/__version__.py

@@ -1 +1 @@
-__version__ = '0.1.0'
+__version__ = '0.2.0'

plex-posters/src/plex_posters/config/config.py

@@ -16,7 +16,8 @@ class Config:
     Attributes
     ----------
     config_file : dict
-        Contains the config options. See :meth:`~plex_posters.config.config.Config.read_config`
+        Contains the config options. See
+        :meth:`~plex_posters.config.config.Config.read_config`
         for the data structure.
     deferred_messages : list
         A list containing the messages to be logged once the logger has been
@@ -46,7 +47,7 @@ class Config:
         path : str
             Path to config file. Should not contain `config.toml`
 
-            Example: `path = '~/.config/plex_posters'`
+            Example: ``path = '~/.config/plex_posters'``
 
         Returns
         -------
@@ -57,14 +58,16 @@ class Config:
             dictionary containing a key, value pair for each config under
             that header.
 
-            Example:
+            Example::
 
-            [plex_posters]
+                [plex_posters]
 
-            [plex_posters.foo]
-            foo = bar
+                [plex_posters.foo]
+                foo = bar
 
-            Returns a dict: {'plex_posters' : {foo: {'foo': 'bar'}}}
+            Returns a dict:
+
+                ``{'plex_posters' : {foo: {'foo': 'bar'}}}``
         """
 
         path += 'config.toml' if path[-1] == '/' else '/config.toml'