From 1470574ff32765e78e3143f5810975d579e37f0f Mon Sep 17 00:00:00 2001 From: Sreekaran Date: Sun, 3 Oct 2021 00:26:02 +0530 Subject: [PATCH 1/4] chore: update docs: link people to anime-dl/anime-downloader (#718) --- README.md | 10 +++++----- anime_downloader/cli.py | 2 +- docs/index.rst | 2 +- docs/usage/installation.rst | 12 ++++++------ setup.py | 2 +- 5 files changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 7ced95e..1831b6b 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,11 @@ A simple yet powerful tool for downloading anime.

- - + + - - + + @@ -52,7 +52,7 @@ Yeah. Me too! That's why this tool exists. * Instructions for Mobile Operating Systems can be found in the [Installation Documentation Page](https://anime-downlader.readthedocs.io/en/latest/usage/installation.html) ## Supported Sites -**Details about the sites can be found in [FAQ](https://github.com/vn-ki/anime-downloader/wiki/FAQ)** +**Details about the sites can be found in [FAQ](https://github.com/anime-dl/anime-downloader/wiki/FAQ)** - AnimePahe diff --git a/anime_downloader/cli.py b/anime_downloader/cli.py index c89de27..007b467 100644 --- a/anime_downloader/cli.py +++ b/anime_downloader/cli.py @@ -68,7 +68,7 @@ def cli(log_level): """ util.setup_logger(log_level) # if not util.check_in_path('aria2c'): - # raise logger.ERROR("Aria2 is not in path. Please follow installation instructions: https://github.com/vn-ki/anime-downloader/wiki/Installation") + # raise logger.ERROR("Aria2 is not in path. Please follow installation instructions: https://github.com/anime-dl/anime-downloader/wiki/Installation") def main(): diff --git a/docs/index.rst b/docs/index.rst index 066167c..0e08a5d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -16,7 +16,7 @@ Features - Search and download. - Save yourselves from those malicious ads. - Download using external downloader ([aria2](https://aria2.github.io/) recommended). -- Configurable using `config.json`. See [doc](https://github.com/vn-ki/anime-downloader/wiki/Config). +- Configurable using `config.json`. See [doc](https://github.com/anime-dl/anime-downloader/wiki/Config). Supported Sites --------------- diff --git a/docs/usage/installation.rst b/docs/usage/installation.rst index 0f7df86..7c0b37e 100644 --- a/docs/usage/installation.rst +++ b/docs/usage/installation.rst @@ -19,14 +19,14 @@ Add the following to a file named install.bat and then run it as Administrator; @"%SystemRoot%\System32\WindowsPowerShell\v1.0\powershell.exe" -NoProfile -InputFormat None -ExecutionPolicy Bypass -Command " [System.Net.ServicePointManager]::SecurityProtocol = 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'))" && SET "PATH=%PATH%;%ALLUSERSPROFILE%\chocolatey\bin" choco install -y git mpv python3 aria2 nodejs - refreshenv && pip3 install -U git+https://github.com/vn-ki/anime-downloader.git && echo Testing providers, the install is done && anime test + refreshenv && pip3 install -U git+https://github.com/anime-dl/anime-downloader.git && echo Testing providers, the install is done && anime test Windows via ``choco`` ~~~~~~~~~~~~~~~~~~~~~ Contributed by @CodaTheOtaku -**NOTE** Ensure the Command Prompt (cmd) is being ran as Administrator. +**NOTE:** Ensure the Command Prompt (cmd) is being ran as Administrator. - Install `Chocolatey`_ Package manager. @@ -35,7 +35,7 @@ Windows via ``choco`` choco install -y git mpv python3 aria2 nodejs - Once these are installed; :: - pip3 install -U git+https://github.com/vn-ki/anime-downloader.git + pip3 install -U git+https://github.com/anime-dl/anime-downloader.git - Then, the commands to view a show would be; :: @@ -65,7 +65,7 @@ all the following ``pip`` with ``pip3``. - To install the bleeding-edge version of Anime-Downloader use this alternative command;: - pip3 install -U git+https://github.com/vn-ki/anime-downloader.git + pip3 install -U git+https://github.com/anime-dl/anime-downloader.git - Enjoy. @@ -98,7 +98,7 @@ This does not require a rooted device to work. - Install Anime-Downloader via the following command after python and git are installed; :: - pip3 install -U git+https://github.com/vn-ki/anime-downloader.git + pip3 install -U git+https://github.com/anime-dl/anime-downloader.git - The usage commands should now match the commands used on PC. @@ -123,7 +123,7 @@ The following steps install Anime-Downloader; - Firstly, clone the repository via this command; :: - git clone https://github.com/vn-ki/anime-downloader.git + git clone https://github.com/anime-dl/anime-downloader.git - Next, change your directory into the cloned repo. To do so, use the following case-sensitive command; :: diff --git a/setup.py b/setup.py index 0aef6c6..24782f6 100644 --- a/setup.py +++ b/setup.py @@ -18,7 +18,7 @@ setup( author_email='vishnunarayan6105@gmail.com', description='Download your favourite anime', packages=find_packages(), - url='https://github.com/vn-ki/anime-downloader', + url='https://github.com/anime-dl/anime-downloader', keywords=['anime', 'downloader', '9anime', 'download', 'kissanime'], install_requires=[ 'pySmartDL>=1.3.4', From 0ad98589efc63e9da3055f7066aa70273358891c Mon Sep 17 00:00:00 2001 From: Sreekaran Date: Sun, 3 Oct 2021 00:33:54 +0530 Subject: [PATCH 2/4] docs: add CONTRIBUTING.md (#719) --- CONTRIBUTING.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..14612f1 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,37 @@ +# Contributing to Support + +Thank you for taking the time to contribute. Please read the [CODE of CONDUCT](CODE_OF_CONDUCT.md). +As a contributor, here are the guidelines we would like you to follow: + +- [Commit Message Guidelines](#commit) + +--- + +## Commit Message Guidelines 😎 + +In order to make git commit messages **easier to read** and faster to reason about, we follow some guidelines on most commits to keep the **format predictable**. Check [Conventional Commits specification](https://conventionalcommits.org) for more information about our guidelines. + +**Examples**: + +``` +docs(changelog): update changelog to beta.5 +docs: add API documentation to the bot +test(server): add cache tests to the movie resource +fix(web): add validation to phone input field +fix(web): remove avatar image from being required in form +fix(release): need to depend on latest rxjs and zone.js +``` + +### Type + +Must be one of the following: + +- **build**: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) +- **ci**: Changes to our CI configuration files and scripts (example scopes: Circle, BrowserStack, SauceLabs) +- **docs**: Documentation only changes +- **feat**: A new feature +- **fix**: A bug fix +- **perf**: A code change that improves performance +- **refactor**: A code change that neither fixes a bug nor adds a feature +- **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) +- **test**: Adding missing tests or correcting existing tests \ No newline at end of file From 4d5457c73f6dba0bceeb3631f4d6f2815bc303cc Mon Sep 17 00:00:00 2001 From: Arjix <53124886+ArjixWasTaken@users.noreply.github.com> Date: Sat, 2 Oct 2021 22:58:35 +0300 Subject: [PATCH 3/4] changed the hash link for "Commit Message Guidelines" --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 14612f1..9f78633 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,11 +3,11 @@ Thank you for taking the time to contribute. Please read the [CODE of CONDUCT](CODE_OF_CONDUCT.md). As a contributor, here are the guidelines we would like you to follow: -- [Commit Message Guidelines](#commit) +- [Commit Message Guidelines](#commit-message-guidelines-) --- -## Commit Message Guidelines 😎 +## Commit Message Guidelines 😎 In order to make git commit messages **easier to read** and faster to reason about, we follow some guidelines on most commits to keep the **format predictable**. Check [Conventional Commits specification](https://conventionalcommits.org) for more information about our guidelines. @@ -34,4 +34,4 @@ Must be one of the following: - **perf**: A code change that improves performance - **refactor**: A code change that neither fixes a bug nor adds a feature - **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) -- **test**: Adding missing tests or correcting existing tests \ No newline at end of file +- **test**: Adding missing tests or correcting existing tests From f76b16135baebdbd8e013e8669a1fbddb570cbcd Mon Sep 17 00:00:00 2001 From: Sreekaran Date: Sun, 3 Oct 2021 12:08:53 +0530 Subject: [PATCH 4/4] docs: edit CONTRIBUTING -- remove link to CoC and introduce a more vague commit message guideline --- CONTRIBUTING.md | 29 ++--------------------------- 1 file changed, 2 insertions(+), 27 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 14612f1..6ddf7ba 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing to Support -Thank you for taking the time to contribute. Please read the [CODE of CONDUCT](CODE_OF_CONDUCT.md). +Thank you for taking the time to contribute. As a contributor, here are the guidelines we would like you to follow: - [Commit Message Guidelines](#commit) @@ -9,29 +9,4 @@ As a contributor, here are the guidelines we would like you to follow: ## Commit Message Guidelines 😎 -In order to make git commit messages **easier to read** and faster to reason about, we follow some guidelines on most commits to keep the **format predictable**. Check [Conventional Commits specification](https://conventionalcommits.org) for more information about our guidelines. - -**Examples**: - -``` -docs(changelog): update changelog to beta.5 -docs: add API documentation to the bot -test(server): add cache tests to the movie resource -fix(web): add validation to phone input field -fix(web): remove avatar image from being required in form -fix(release): need to depend on latest rxjs and zone.js -``` - -### Type - -Must be one of the following: - -- **build**: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) -- **ci**: Changes to our CI configuration files and scripts (example scopes: Circle, BrowserStack, SauceLabs) -- **docs**: Documentation only changes -- **feat**: A new feature -- **fix**: A bug fix -- **perf**: A code change that improves performance -- **refactor**: A code change that neither fixes a bug nor adds a feature -- **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) -- **test**: Adding missing tests or correcting existing tests \ No newline at end of file +Nothing much honestly, just briefly describe the changes you made and you're good to go. \ No newline at end of file