Merge pull request #72 from the-dotify-project/development

Enriching the project's documentation

Author: billsioros

.flake8

@@ -11,6 +11,7 @@ exclude =
     dist
     docs
     examples
+    tests
     __pycache__
 extend-ignore =
     E203,
@@ -29,4 +30,8 @@ extend-ignore =
     WPS433,
     WPS412,
     WPS410,
-    WPS323
+    WPS323,
+    D105,
+    D106,
+    RST,
+    WPS436 # https://github.com/wemake-services/wemake-python-styleguide/issues/1441

.pre-commit-config.yaml

@@ -1,4 +1,9 @@
 repos:
+  - repo: https://github.com/humitos/mirrors-autoflake.git
+    rev: v1.3
+    hooks:
+      - id: autoflake
+        args: ['--in-place', '--remove-all-unused-imports', '--remove-unused-variable']
   - repo: https://github.com/pycqa/isort
     rev: 5.8.0
     hooks:
@@ -12,6 +17,7 @@ repos:
     rev: 3.9.2
     hooks:
       - id: flake8
+        exclude: ^docs|examples|tests
         additional_dependencies: [wemake_python_styleguide]
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.0.1
@@ -37,3 +43,7 @@ repos:
     rev: 2.3.5
     hooks:
       - id: editorconfig-checker
+  - repo: https://github.com/jendrikseipp/vulture
+    rev: v2.3
+    hooks:
+      - id: vulture

README.md

@@ -25,13 +25,13 @@
       alt="docs"
     />
   </a>
-  <a href="https://codeclimate.com/github/the-dotify-project/dotify/maintainability">
+  <a href="https://codeclimate.com/github/billsioros/dotify/maintainability">
     <img
       src="https://api.codeclimate.com/v1/badges/573685a448c6422d49de/maintainability"
       alt="Maintainability"
     />
   </a>
-  <a href="https://codeclimate.com/github/the-dotify-project/dotify/test_coverage">
+  <a href="https://codeclimate.com/github/billsioros/dotify/test_coverage">
     <img
       src="https://api.codeclimate.com/v1/badges/573685a448c6422d49de/test_coverage"
       alt="Test Coverage"

docs/decorators.md

@@ -0,0 +1,3 @@
+# Documentation for `Dotify`
+
+::: dotify._model.Model

docs/json_serializable.md

@@ -1,3 +1,5 @@
 # Documentation for `Album`
 
-::: dotify.Album
+::: dotify.models._album.AlbumBase
+
+::: dotify.models._album.Album

docs/model.md

@@ -1,3 +1,5 @@
 # Documentation for `Playlist`
 
-::: dotify.Playlist
+::: dotify.models._playlist.PlaylistBase
+
+::: dotify.models._playlist.Playlist

docs/models/album.md

@@ -1,3 +1,5 @@
 # Documentation for `Track`
 
-::: dotify.Track
+::: dotify.models._track.TrackBase
+
+::: dotify.models._track.Track

docs/models/playlist.md

@@ -1,11 +1,20 @@
+"""Yet another Spotify Web API Python library.
+
+Examples:
+---
+    >>> from dotify import Dotify, Track
+    >>> with Dotify(SPOTIFY_ID, SPOTIFY_SECRET):
+    >>>     result = next(Track.search("SAINt JHN 5 Thousand Singles", limit=1))
+    >>> result
+    <Track "SAINt JHN - 5 Thousand Singles">
+    >>> result.url
+    'https://open.spotify.com/track/0fFWxRZGKR7HDW2xBMOZgW'
+    >>> result.download("SAINt JHN - 5 Thousand Singles.mp3")
+    PosixPath('SAINt JHN - 5 Thousand Singles.mp3')
+"""
+
 __all__ = [
     "Dotify",
-    "Album",
-    "Playlist",
-    "Track",
 ]
 
-from dotify.dotify import Dotify
-from dotify.models.album import Album
-from dotify.models.playlist import Playlist
-from dotify.models.track import Track
+from dotify._dotify import Dotify