1
0
Fork 0
mirror of synced 2024-05-17 18:52:46 +12:00

Rename module

This commit is contained in:
Serene-Arc 2021-04-12 17:58:32 +10:00 committed by Ali Parlakci
parent 3da58dbd5d
commit bd9f276acc
57 changed files with 139 additions and 139 deletions

View file

@ -4,10 +4,10 @@ This is a tool to download submissions or submission data from Reddit. It can be
Some quick reference commands are:
- `python3 -m bulkredditdownloader download --subreddit Python -L 10`
- `python3 -m bulkredditdownloader download --user me --saved --authenticate -L 25 --file-scheme '{POSTID}'`
- `python3 -m bulkredditdownloader download --subreddit 'Python, all, mindustry' -L 10 --make-hard-links`
- `python3 -m bulkredditdownloader archive --subreddit all --format yaml -L 500 --folder-scheme ''`
- `python3 -m bdfr download --subreddit Python -L 10`
- `python3 -m bdfr download --user me --saved --authenticate -L 25 --file-scheme '{POSTID}'`
- `python3 -m bdfr download --subreddit 'Python, all, mindustry' -L 10 --make-hard-links`
- `python3 -m bdfr archive --subreddit all --format yaml -L 500 --folder-scheme ''`
## Usage
@ -189,14 +189,14 @@ It is highly recommended that the file name scheme contain the parameter `{POSTI
## Configuration
The configuration files are, by default, stored in the configuration directory for the user. This differs depending on the OS that the BDFR is being run on. For Windows, this will be:
- `C:\Documents and Settings\<User>\Application Data\Local Settings\BDFR\bulkredditdownloader` or
- `C:\Documents and Settings\<User>\Application Data\BDFR\bulkredditdownloader`
- `C:\Documents and Settings\<User>\Application Data\Local Settings\BDFR\bdfr` or
- `C:\Documents and Settings\<User>\Application Data\BDFR\bdfr`
On Mac OSX, this will be:
- `~/Library/Application Support/bulkredditdownloader`.
- `~/Library/Application Support/bdfr`.
Lastly, on a Linux system, this will be:
- `~/.local/share/bulkredditdownloader`
- `~/.local/share/bdfr`
The logging output for each run of the BDFR will be saved to this directory in the file `log_output.txt`. If you need to submit a bug, it is this file that you will need to submit with the report.

View file

@ -5,9 +5,9 @@ import sys
import click
from bulkredditdownloader.archiver import Archiver
from bulkredditdownloader.configuration import Configuration
from bulkredditdownloader.downloader import RedditDownloader
from bdfr.archiver import Archiver
from bdfr.configuration import Configuration
from bdfr.downloader import RedditDownloader
logger = logging.getLogger()

View file

@ -5,7 +5,7 @@ import logging
import praw.models
from bulkredditdownloader.archive_entry.base_archive_entry import BaseArchiveEntry
from bdfr.archive_entry.base_archive_entry import BaseArchiveEntry
logger = logging.getLogger(__name__)

View file

@ -5,7 +5,7 @@ import logging
import praw.models
from bulkredditdownloader.archive_entry.base_archive_entry import BaseArchiveEntry
from bdfr.archive_entry.base_archive_entry import BaseArchiveEntry
logger = logging.getLogger(__name__)

View file

@ -10,13 +10,13 @@ import dict2xml
import praw.models
import yaml
from bulkredditdownloader.archive_entry.base_archive_entry import BaseArchiveEntry
from bulkredditdownloader.archive_entry.comment_archive_entry import CommentArchiveEntry
from bulkredditdownloader.archive_entry.submission_archive_entry import SubmissionArchiveEntry
from bulkredditdownloader.configuration import Configuration
from bulkredditdownloader.downloader import RedditDownloader
from bulkredditdownloader.exceptions import ArchiverError
from bulkredditdownloader.resource import Resource
from bdfr.archive_entry.base_archive_entry import BaseArchiveEntry
from bdfr.archive_entry.comment_archive_entry import CommentArchiveEntry
from bdfr.archive_entry.submission_archive_entry import SubmissionArchiveEntry
from bdfr.configuration import Configuration
from bdfr.downloader import RedditDownloader
from bdfr.exceptions import ArchiverError
from bdfr.resource import Resource
logger = logging.getLogger(__name__)

View file

@ -22,13 +22,13 @@ import praw.exceptions
import praw.models
import prawcore
import bulkredditdownloader.exceptions as errors
from bulkredditdownloader.configuration import Configuration
from bulkredditdownloader.download_filter import DownloadFilter
from bulkredditdownloader.file_name_formatter import FileNameFormatter
from bulkredditdownloader.oauth2 import OAuth2Authenticator, OAuth2TokenManager
from bulkredditdownloader.site_authenticator import SiteAuthenticator
from bulkredditdownloader.site_downloaders.download_factory import DownloadFactory
import bdfr.exceptions as errors
from bdfr.configuration import Configuration
from bdfr.download_filter import DownloadFilter
from bdfr.file_name_formatter import FileNameFormatter
from bdfr.oauth2 import OAuth2Authenticator, OAuth2TokenManager
from bdfr.site_authenticator import SiteAuthenticator
from bdfr.site_downloaders.download_factory import DownloadFactory
logger = logging.getLogger(__name__)
@ -59,7 +59,7 @@ class RedditTypes:
class RedditDownloader:
def __init__(self, args: Configuration):
self.args = args
self.config_directories = appdirs.AppDirs('bulkredditdownloader', 'BDFR')
self.config_directories = appdirs.AppDirs('bdfr', 'BDFR')
self.run_time = datetime.now().isoformat()
self._setup_internal_objects()
@ -178,7 +178,7 @@ class RedditDownloader:
logger.debug(f'Loading configuration from {path}')
break
if not self.config_location:
self.config_location = list(importlib.resources.path('bulkredditdownloader', 'default_config.cfg').gen)[0]
self.config_location = list(importlib.resources.path('bdfr', 'default_config.cfg').gen)[0]
shutil.copy(self.config_location, Path(self.config_directory, 'default_config.cfg'))
if not self.config_location:
raise errors.BulkDownloaderException('Could not find a configuration file to load')

View file

@ -9,8 +9,8 @@ from typing import Optional
from praw.models import Comment, Submission
from bulkredditdownloader.exceptions import BulkDownloaderException
from bulkredditdownloader.resource import Resource
from bdfr.exceptions import BulkDownloaderException
from bdfr.resource import Resource
logger = logging.getLogger(__name__)

View file

@ -11,7 +11,7 @@ from pathlib import Path
import praw
import requests
from bulkredditdownloader.exceptions import BulkDownloaderException, RedditAuthenticationError
from bdfr.exceptions import BulkDownloaderException, RedditAuthenticationError
logger = logging.getLogger(__name__)

View file

@ -11,7 +11,7 @@ import _hashlib
import requests
from praw.models import Submission
from bulkredditdownloader.exceptions import BulkDownloaderException
from bdfr.exceptions import BulkDownloaderException
logger = logging.getLogger(__name__)

View file

@ -8,9 +8,9 @@ from typing import Optional
import requests
from praw.models import Submission
from bulkredditdownloader.exceptions import ResourceNotFound
from bulkredditdownloader.resource import Resource
from bulkredditdownloader.site_authenticator import SiteAuthenticator
from bdfr.exceptions import ResourceNotFound
from bdfr.resource import Resource
from bdfr.site_authenticator import SiteAuthenticator
logger = logging.getLogger(__name__)

View file

@ -4,9 +4,9 @@ from typing import Optional
from praw.models import Submission
from bulkredditdownloader.site_authenticator import SiteAuthenticator
from bulkredditdownloader.resource import Resource
from bulkredditdownloader.site_downloaders.base_downloader import BaseDownloader
from bdfr.site_authenticator import SiteAuthenticator
from bdfr.resource import Resource
from bdfr.site_downloaders.base_downloader import BaseDownloader
class Direct(BaseDownloader):

View file

@ -4,18 +4,18 @@
import re
from typing import Type
from bulkredditdownloader.exceptions import NotADownloadableLinkError
from bulkredditdownloader.site_downloaders.base_downloader import BaseDownloader
from bulkredditdownloader.site_downloaders.direct import Direct
from bulkredditdownloader.site_downloaders.erome import Erome
from bulkredditdownloader.site_downloaders.gallery import Gallery
from bulkredditdownloader.site_downloaders.gfycat import Gfycat
from bulkredditdownloader.site_downloaders.gif_delivery_network import GifDeliveryNetwork
from bulkredditdownloader.site_downloaders.imgur import Imgur
from bulkredditdownloader.site_downloaders.redgifs import Redgifs
from bulkredditdownloader.site_downloaders.self_post import SelfPost
from bulkredditdownloader.site_downloaders.vreddit import VReddit
from bulkredditdownloader.site_downloaders.youtube import Youtube
from bdfr.exceptions import NotADownloadableLinkError
from bdfr.site_downloaders.base_downloader import BaseDownloader
from bdfr.site_downloaders.direct import Direct
from bdfr.site_downloaders.erome import Erome
from bdfr.site_downloaders.gallery import Gallery
from bdfr.site_downloaders.gfycat import Gfycat
from bdfr.site_downloaders.gif_delivery_network import GifDeliveryNetwork
from bdfr.site_downloaders.imgur import Imgur
from bdfr.site_downloaders.redgifs import Redgifs
from bdfr.site_downloaders.self_post import SelfPost
from bdfr.site_downloaders.vreddit import VReddit
from bdfr.site_downloaders.youtube import Youtube
class DownloadFactory:

View file

@ -7,10 +7,10 @@ from typing import Optional
import bs4
from praw.models import Submission
from bulkredditdownloader.exceptions import SiteDownloaderError
from bulkredditdownloader.resource import Resource
from bulkredditdownloader.site_authenticator import SiteAuthenticator
from bulkredditdownloader.site_downloaders.base_downloader import BaseDownloader
from bdfr.exceptions import SiteDownloaderError
from bdfr.resource import Resource
from bdfr.site_authenticator import SiteAuthenticator
from bdfr.site_downloaders.base_downloader import BaseDownloader
logger = logging.getLogger(__name__)

View file

@ -7,10 +7,10 @@ from typing import Optional
import bs4
from praw.models import Submission
from bulkredditdownloader.exceptions import SiteDownloaderError
from bulkredditdownloader.resource import Resource
from bulkredditdownloader.site_authenticator import SiteAuthenticator
from bulkredditdownloader.site_downloaders.base_downloader import BaseDownloader
from bdfr.exceptions import SiteDownloaderError
from bdfr.resource import Resource
from bdfr.site_authenticator import SiteAuthenticator
from bdfr.site_downloaders.base_downloader import BaseDownloader
logger = logging.getLogger(__name__)

View file

@ -7,10 +7,10 @@ from typing import Optional
from bs4 import BeautifulSoup
from praw.models import Submission
from bulkredditdownloader.exceptions import SiteDownloaderError
from bulkredditdownloader.resource import Resource
from bulkredditdownloader.site_authenticator import SiteAuthenticator
from bulkredditdownloader.site_downloaders.gif_delivery_network import GifDeliveryNetwork
from bdfr.exceptions import SiteDownloaderError
from bdfr.resource import Resource
from bdfr.site_authenticator import SiteAuthenticator
from bdfr.site_downloaders.gif_delivery_network import GifDeliveryNetwork
class Gfycat(GifDeliveryNetwork):

View file

@ -5,10 +5,10 @@ from typing import Optional
from bs4 import BeautifulSoup
from praw.models import Submission
from bulkredditdownloader.exceptions import NotADownloadableLinkError, SiteDownloaderError
from bulkredditdownloader.resource import Resource
from bulkredditdownloader.site_authenticator import SiteAuthenticator
from bulkredditdownloader.site_downloaders.base_downloader import BaseDownloader
from bdfr.exceptions import NotADownloadableLinkError, SiteDownloaderError
from bdfr.resource import Resource
from bdfr.site_authenticator import SiteAuthenticator
from bdfr.site_downloaders.base_downloader import BaseDownloader
class GifDeliveryNetwork(BaseDownloader):

View file

@ -7,10 +7,10 @@ from typing import Optional
import bs4
from praw.models import Submission
from bulkredditdownloader.exceptions import NotADownloadableLinkError, SiteDownloaderError
from bulkredditdownloader.resource import Resource
from bulkredditdownloader.site_authenticator import SiteAuthenticator
from bulkredditdownloader.site_downloaders.base_downloader import BaseDownloader
from bdfr.exceptions import NotADownloadableLinkError, SiteDownloaderError
from bdfr.resource import Resource
from bdfr.site_authenticator import SiteAuthenticator
from bdfr.site_downloaders.base_downloader import BaseDownloader
class Imgur(BaseDownloader):

View file

@ -7,10 +7,10 @@ from typing import Optional
from bs4 import BeautifulSoup
from praw.models import Submission
from bulkredditdownloader.exceptions import NotADownloadableLinkError, SiteDownloaderError
from bulkredditdownloader.resource import Resource
from bulkredditdownloader.site_authenticator import SiteAuthenticator
from bulkredditdownloader.site_downloaders.gif_delivery_network import GifDeliveryNetwork
from bdfr.exceptions import NotADownloadableLinkError, SiteDownloaderError
from bdfr.resource import Resource
from bdfr.site_authenticator import SiteAuthenticator
from bdfr.site_downloaders.gif_delivery_network import GifDeliveryNetwork
class Redgifs(GifDeliveryNetwork):

View file

@ -5,9 +5,9 @@ from typing import Optional
from praw.models import Submission
from bulkredditdownloader.resource import Resource
from bulkredditdownloader.site_authenticator import SiteAuthenticator
from bulkredditdownloader.site_downloaders.base_downloader import BaseDownloader
from bdfr.resource import Resource
from bdfr.site_authenticator import SiteAuthenticator
from bdfr.site_downloaders.base_downloader import BaseDownloader
logger = logging.getLogger(__name__)

View file

@ -5,9 +5,9 @@ from typing import Optional
from praw.models import Submission
from bulkredditdownloader.resource import Resource
from bulkredditdownloader.site_authenticator import SiteAuthenticator
from bulkredditdownloader.site_downloaders.youtube import Youtube
from bdfr.resource import Resource
from bdfr.site_authenticator import SiteAuthenticator
from bdfr.site_downloaders.youtube import Youtube
logger = logging.getLogger(__name__)

View file

@ -8,10 +8,10 @@ from typing import Optional
import youtube_dl
from praw.models import Submission
from bulkredditdownloader.exceptions import SiteDownloaderError
from bulkredditdownloader.resource import Resource
from bulkredditdownloader.site_authenticator import SiteAuthenticator
from bulkredditdownloader.site_downloaders.base_downloader import BaseDownloader
from bdfr.exceptions import SiteDownloaderError
from bdfr.resource import Resource
from bdfr.site_authenticator import SiteAuthenticator
from bdfr.site_downloaders.base_downloader import BaseDownloader
logger = logging.getLogger(__name__)

View file

@ -4,7 +4,7 @@
import praw
import pytest
from bulkredditdownloader.archive_entry.comment_archive_entry import CommentArchiveEntry
from bdfr.archive_entry.comment_archive_entry import CommentArchiveEntry
@pytest.mark.online

View file

@ -4,7 +4,7 @@
import praw
import pytest
from bulkredditdownloader.archive_entry.submission_archive_entry import SubmissionArchiveEntry
from bdfr.archive_entry.submission_archive_entry import SubmissionArchiveEntry
@pytest.mark.online

View file

@ -8,7 +8,7 @@ from pathlib import Path
import praw
import pytest
from bulkredditdownloader.oauth2 import OAuth2TokenManager
from bdfr.oauth2 import OAuth2TokenManager
@pytest.fixture(scope='session')

View file

@ -5,8 +5,8 @@ from unittest.mock import Mock
import pytest
from bulkredditdownloader.resource import Resource
from bulkredditdownloader.site_downloaders.direct import Direct
from bdfr.resource import Resource
from bdfr.site_downloaders.direct import Direct
@pytest.mark.online

View file

@ -4,19 +4,19 @@
import praw
import pytest
from bulkredditdownloader.exceptions import NotADownloadableLinkError
from bulkredditdownloader.site_downloaders.base_downloader import BaseDownloader
from bulkredditdownloader.site_downloaders.direct import Direct
from bulkredditdownloader.site_downloaders.download_factory import DownloadFactory
from bulkredditdownloader.site_downloaders.erome import Erome
from bulkredditdownloader.site_downloaders.gallery import Gallery
from bulkredditdownloader.site_downloaders.gfycat import Gfycat
from bulkredditdownloader.site_downloaders.gif_delivery_network import GifDeliveryNetwork
from bulkredditdownloader.site_downloaders.imgur import Imgur
from bulkredditdownloader.site_downloaders.redgifs import Redgifs
from bulkredditdownloader.site_downloaders.self_post import SelfPost
from bulkredditdownloader.site_downloaders.vreddit import VReddit
from bulkredditdownloader.site_downloaders.youtube import Youtube
from bdfr.exceptions import NotADownloadableLinkError
from bdfr.site_downloaders.base_downloader import BaseDownloader
from bdfr.site_downloaders.direct import Direct
from bdfr.site_downloaders.download_factory import DownloadFactory
from bdfr.site_downloaders.erome import Erome
from bdfr.site_downloaders.gallery import Gallery
from bdfr.site_downloaders.gfycat import Gfycat
from bdfr.site_downloaders.gif_delivery_network import GifDeliveryNetwork
from bdfr.site_downloaders.imgur import Imgur
from bdfr.site_downloaders.redgifs import Redgifs
from bdfr.site_downloaders.self_post import SelfPost
from bdfr.site_downloaders.vreddit import VReddit
from bdfr.site_downloaders.youtube import Youtube
@pytest.mark.parametrize(('test_submission_url', 'expected_class'), (

View file

@ -5,7 +5,7 @@ from unittest.mock import MagicMock
import pytest
from bulkredditdownloader.site_downloaders.erome import Erome
from bdfr.site_downloaders.erome import Erome
@pytest.mark.online

View file

@ -4,7 +4,7 @@
import praw
import pytest
from bulkredditdownloader.site_downloaders.gallery import Gallery
from bdfr.site_downloaders.gallery import Gallery
@pytest.mark.online

View file

@ -5,8 +5,8 @@ from unittest.mock import Mock
import pytest
from bulkredditdownloader.resource import Resource
from bulkredditdownloader.site_downloaders.gfycat import Gfycat
from bdfr.resource import Resource
from bdfr.site_downloaders.gfycat import Gfycat
@pytest.mark.online

View file

@ -5,8 +5,8 @@ from unittest.mock import Mock
import pytest
from bulkredditdownloader.resource import Resource
from bulkredditdownloader.site_downloaders.gif_delivery_network import GifDeliveryNetwork
from bdfr.resource import Resource
from bdfr.site_downloaders.gif_delivery_network import GifDeliveryNetwork
@pytest.mark.online

View file

@ -5,9 +5,9 @@ from unittest.mock import Mock
import pytest
from bulkredditdownloader.exceptions import SiteDownloaderError
from bulkredditdownloader.resource import Resource
from bulkredditdownloader.site_downloaders.imgur import Imgur
from bdfr.exceptions import SiteDownloaderError
from bdfr.resource import Resource
from bdfr.site_downloaders.imgur import Imgur
@pytest.mark.online

View file

@ -5,8 +5,8 @@ from unittest.mock import Mock
import pytest
from bulkredditdownloader.resource import Resource
from bulkredditdownloader.site_downloaders.redgifs import Redgifs
from bdfr.resource import Resource
from bdfr.site_downloaders.redgifs import Redgifs
@pytest.mark.online

View file

@ -4,8 +4,8 @@
import praw
import pytest
from bulkredditdownloader.resource import Resource
from bulkredditdownloader.site_downloaders.self_post import SelfPost
from bdfr.resource import Resource
from bdfr.site_downloaders.self_post import SelfPost
@pytest.mark.online

View file

@ -4,8 +4,8 @@
import praw
import pytest
from bulkredditdownloader.resource import Resource
from bulkredditdownloader.site_downloaders.vreddit import VReddit
from bdfr.resource import Resource
from bdfr.site_downloaders.vreddit import VReddit
@pytest.mark.online

View file

@ -5,8 +5,8 @@ from unittest.mock import MagicMock
import pytest
from bulkredditdownloader.resource import Resource
from bulkredditdownloader.site_downloaders.youtube import Youtube
from bdfr.resource import Resource
from bdfr.site_downloaders.youtube import Youtube
@pytest.mark.online

View file

@ -7,8 +7,8 @@ from unittest.mock import MagicMock
import praw
import pytest
from bulkredditdownloader.archive_entry.submission_archive_entry import SubmissionArchiveEntry
from bulkredditdownloader.archiver import Archiver
from bdfr.archive_entry.submission_archive_entry import SubmissionArchiveEntry
from bdfr.archiver import Archiver
@pytest.mark.online

View file

@ -5,7 +5,7 @@ from unittest.mock import MagicMock
import pytest
from bulkredditdownloader.configuration import Configuration
from bdfr.configuration import Configuration
@pytest.mark.parametrize('arg_dict', (

View file

@ -3,7 +3,7 @@
import pytest
from bulkredditdownloader.download_filter import DownloadFilter
from bdfr.download_filter import DownloadFilter
@pytest.fixture()

View file

@ -10,13 +10,13 @@ import praw
import praw.models
import pytest
from bulkredditdownloader.__main__ import setup_logging
from bulkredditdownloader.configuration import Configuration
from bulkredditdownloader.download_filter import DownloadFilter
from bulkredditdownloader.downloader import RedditDownloader, RedditTypes
from bulkredditdownloader.exceptions import BulkDownloaderException
from bulkredditdownloader.file_name_formatter import FileNameFormatter
from bulkredditdownloader.site_authenticator import SiteAuthenticator
from bdfr.__main__ import setup_logging
from bdfr.configuration import Configuration
from bdfr.download_filter import DownloadFilter
from bdfr.downloader import RedditDownloader, RedditTypes
from bdfr.exceptions import BulkDownloaderException
from bdfr.file_name_formatter import FileNameFormatter
from bdfr.site_authenticator import SiteAuthenticator
@pytest.fixture()

View file

@ -8,8 +8,8 @@ from unittest.mock import MagicMock
import praw.models
import pytest
from bulkredditdownloader.file_name_formatter import FileNameFormatter
from bulkredditdownloader.resource import Resource
from bdfr.file_name_formatter import FileNameFormatter
from bdfr.resource import Resource
@pytest.fixture()

View file

@ -7,7 +7,7 @@ from pathlib import Path
import pytest
from click.testing import CliRunner
from bulkredditdownloader.__main__ import cli
from bdfr.__main__ import cli
@pytest.mark.online

View file

@ -7,8 +7,8 @@ from unittest.mock import MagicMock
import pytest
from bulkredditdownloader.exceptions import BulkDownloaderException
from bulkredditdownloader.oauth2 import OAuth2Authenticator, OAuth2TokenManager
from bdfr.exceptions import BulkDownloaderException
from bdfr.oauth2 import OAuth2Authenticator, OAuth2TokenManager
@pytest.fixture()

View file

@ -4,7 +4,7 @@
import pytest
from unittest.mock import MagicMock
from bulkredditdownloader.resource import Resource
from bdfr.resource import Resource
@pytest.mark.parametrize(('test_url', 'expected'), (

View file

@ -5,4 +5,4 @@ author-email = parlakciali@gmail.com
python_requires = >=3.9
[files]
packages = bulkredditdownloader
packages = bdfr

View file

@ -3,4 +3,4 @@
from setuptools import setup
setup(setup_requires=['pbr', 'appdirs'], pbr=True, data_files=[('config', ['bulkredditdownloader/default_config.cfg'])])
setup(setup_requires=['pbr', 'appdirs'], pbr=True, data_files=[('config', ['bdfr/default_config.cfg'])])