Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Iteration 'stable beta 1' #13

Merged
merged 26 commits into from
Mar 3, 2022
Merged
Changes from 1 commit
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
16c80cb
chore: :heavy_plus_sign: Add 'furo' (2022.2.14) RTD theme and remove …
hotenov Feb 18, 2022
137daa8
build: :construction_worker: Integrate Furo them into Nox sessions an…
hotenov Feb 18, 2022
347b925
chore: :arrow_up: Upgrade python to ^3.8.0
hotenov Feb 18, 2022
95dab7e
docs: :memo: Update boilerplate README
hotenov Feb 21, 2022
8200206
docs: :memo: Add manpage (renamed usage) and update generated help ou…
hotenov Feb 21, 2022
4f07573
docs: :memo: Add 'Usage Examples' page
hotenov Feb 23, 2022
bbf76fd
docs: :memo: Add Motivation page
hotenov Feb 23, 2022
1d5cbec
build: :memo: Update reference.rst bu adding auto generated descripti…
hotenov Feb 25, 2022
a7b6f6f
docs: :memo: Update Readme using anonymous reference ('double undersc…
hotenov Feb 25, 2022
eac6b0a
docs: :memo: Add detailed docstrings for 'lep.py'
hotenov Feb 27, 2022
fb7fc60
test(console): :white_check_mark: Update two test to fix concurrency …
hotenov Feb 27, 2022
9789a43
docs(downloader): :memo: Add docstrings for 'downloader.py'
hotenov Feb 28, 2022
63757e4
docs(parser): :memo: Add docstrings for 'parser.py'
hotenov Mar 1, 2022
ea20629
docs: :memo: Add docstrings for 'exceptions.py'
hotenov Mar 1, 2022
33bbaff
docs: :memo: Fix two little mistakes in lep's docstrings
hotenov Mar 1, 2022
3031399
style: :rotating_light: Fix linter errors by 'pre-commit' session
hotenov Mar 1, 2022
16d1b97
chore: :wrench: Update .flake8 config to set max-line-length = 80
hotenov Mar 1, 2022
454d091
docs(console): :memo: Update metavar values for path options and '--e…
hotenov Mar 1, 2022
88b1696
docs: :memo: Update links to Example Usage and Man Page, Add link to …
hotenov Mar 1, 2022
ff0799e
chore: :wrench: Update config constants with production URLs
hotenov Mar 1, 2022
f15f4fe
fix: :bug: Correct 'short_date' property for LepEpisode (must be orig…
hotenov Mar 3, 2022
5349e00
docs: :memo: Add LEP YouTube link on Readme and update required time …
hotenov Mar 3, 2022
7650451
fix: :bug: Fix wrong short date again (episode datetime is not conver…
hotenov Mar 3, 2022
c262d66
test: :white_check_mark: Add tests to check date filter for date clos…
hotenov Mar 3, 2022
7be2760
chore: Bump to 3.0.0b1
hotenov Mar 3, 2022
7e6542a
test(console): :white_check_mark: Update version checking (just "3.")
hotenov Mar 3, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
build: 📝 Update reference.rst bu adding auto generated description fo…
…r 4 main modules
hotenov committed Feb 25, 2022

Verified

This commit was signed with the committer’s verified signature.
hotenov artem
commit 1d5cbec0713d6514acd792ede6c52e62ed57a3f2
45 changes: 37 additions & 8 deletions docs/reference.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,42 @@
Reference
=========
Developer Reference
===================

.. contents::
:local:
:backlinks: none
Classes and functions definitions for main modules.
All descriptions are generated automatically
from code docstrings.


lep_downloader.cli
-----------------------

.. automodule:: lep_downloader.cli
lep_downloader.lep
--------------------------

.. automodule:: lep_downloader.lep
:members:
:undoc-members:
:show-inheritance:


lep_downloader.downloader
--------------------------

.. automodule:: lep_downloader.downloader
:members:
:undoc-members:
:show-inheritance:


lep_downloader.parser
--------------------------

.. automodule:: lep_downloader.parser
:members:
:undoc-members:
:show-inheritance:

lep_downloader.exceptions
--------------------------

.. automodule:: lep_downloader.exceptions
:members:
:undoc-members:
:show-inheritance:
19 changes: 10 additions & 9 deletions src/lep_downloader/downloader.py
Original file line number Diff line number Diff line change
@@ -279,22 +279,23 @@ def download_and_write_file(


class LepDL(Lep):
"""Represent downloader object."""
"""Represent downloader object.
Args:
json_url (str): URL to JSON database
session (requests.Session): Requests session object
if None, get default global session.
log (LepLog): Log instance of LepLog class where to output message.
"""

def __init__(
self,
json_url: str = conf.JSON_DB_URL,
session: requests.Session = None,
log: Optional[LepLog] = None,
) -> None:
"""Initialize LepDL object.
Args:
json_url (str): URL to JSON datavase
session (requests.Session): Requests session object
if None, get default global session.
log (LepLog): Log instance of LepLog class where to output message.
"""
"""Initialize LepDL object."""
super().__init__(session, log)
self.json_url = json_url
self.db_episodes: LepEpisodeList = LepEpisodeList()
2 changes: 1 addition & 1 deletion src/lep_downloader/parser.py
Original file line number Diff line number Diff line change
@@ -461,7 +461,7 @@ def remove_irrelevant_links(self) -> None:
"""Delete known irrelevant links from dictionary.
First, write irrelevant links into 'deleted_links'
before deletion them from dictionary.
before deletion them from dictionary.
Then rebuild dictionary skipping irrelevant links.
"""
self.archive.deleted_links = {