mirror of
https://github.com/Benexl/FastAnime.git
synced 2025-12-27 21:23:39 -08:00
feat(readme):updated readme
This commit is contained in:
Benex254
BIN
.assets/screencasts/fastanime_demo.webm
Normal file
BIN
.assets/screencasts/fastanime_demo.webm
Normal file
Binary file not shown.
105
README.md
105
README.md
@@ -1,40 +1,77 @@
|
||||
````markdown
|
||||
# Fast Anime
|
||||
|
||||
# FastAnime
|
||||
Welcome to Fast Anime, your new favorite destination for streaming and downloading anime.
|
||||
|
||||
The best and only gui anime scrapper for your benefit.
|
||||
|
||||
|
||||
# Screenshots
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Authors
|
||||
|
||||
- [@Benex254](https://github.com/Benex254/aniXstream)
|
||||
## Table of Contents
|
||||
|
||||
- [Installation](#installation)
|
||||
- [Using pip](#using-pip)
|
||||
- [Using pipx](#using-pipx)
|
||||
- [Pre-built binaries](#pre-built-binaries)
|
||||
- [Building from the source](#building-from-the-source)
|
||||
- [Major Dependencies](#major-dependencies)
|
||||
- [Contributing](#contributing)
|
||||
- [Receiving Support](#receiving-support)
|
||||
- [Supporting the Project](#supporting-the-project)
|
||||
|
||||
## Installation
|
||||
The project is undergoing some changes though you can always get a working legacy version by cloning the legacy branch
|
||||
Or for windows users to go to the first releases, this is the link to download the installer [anixstream installer](https://github.com/Benex254/aniXstream/releases/download/v0.10.0/AniXStream.Installer.exe)
|
||||
|
||||
### Using pip
|
||||
|
||||
Fast Anime can be installed using pip with the following command:
|
||||
|
||||
```bash
|
||||
pip install <package-name>
|
||||
#then you can launch the app using the following command:
|
||||
python -m fastanime
|
||||
```
|
||||
````
|
||||
|
||||
> [!TIP]
|
||||
> To add a desktop entry, execute the following command:
|
||||
>
|
||||
> ```bash
|
||||
> python -m fastanime.ensure_desktop_icon
|
||||
> ```
|
||||
|
||||
### Using pipx
|
||||
|
||||
Currently, this method is not functional. Please use the pip installation method instead.
|
||||
|
||||
### Pre-built binaries
|
||||
|
||||
We will soon release pre-built binaries for Linux and Windows.
|
||||
|
||||
### Building from the source
|
||||
|
||||
To build from the source, follow these steps:
|
||||
|
||||
1. Clone the repository: `git clone https://github.com/Benex254/FastAnime.git`
|
||||
2. Navigate into the folder: `cd FastAnime`
|
||||
3. create the virtual environment: `python -m venv .venv`
|
||||
4. Activate the virtual environment: `source .venv/bin/activate` or on windows `.venv/scripts/activate`
|
||||
5. Install dependencies: `pip install -r requirements.txt`
|
||||
6. Build the app with: `python -m build`; ensure build is installed first.
|
||||
7. Navigate to the dist folder: `cd dist`
|
||||
8. Install the app with: `pip install fastanime-0.2.0-py3-none-any.whl`
|
||||
|
||||
## Major Dependencies
|
||||
|
||||
- Kivy and KivyMD for the UI
|
||||
- PyShortcuts for creating a desktop icon
|
||||
- FuzzyWuzzy for auto-selecting search results from the provider
|
||||
|
||||
## Contributing
|
||||
|
||||
We welcome your issues and feature requests. However, we currently have no plans to add another provider, so issues related to this may not be addressed due to time constraints. If you wish to contribute directly, please open an issue detailing the changes you wish to add and request a PR.
|
||||
|
||||
## Receiving Support
|
||||
|
||||
If you have any inquiries, join our Discord server: `<Discord-server-link>`
|
||||
|
||||
## Supporting the Project
|
||||
|
||||
If you want to support the project, please consider leaving a star on our GitHub repository or [buying us a coffee](ko-fi.com/benex254). We appreciate both!
|
||||
|
||||
@@ -2,6 +2,7 @@ import os
|
||||
import plyer
|
||||
from kivy.resources import resource_add_path
|
||||
|
||||
# print(plyer.storagepath.get_application_dir(), plyer.storagepath.get_home_dir())
|
||||
app_dir = os.path.abspath(os.path.dirname(__file__))
|
||||
|
||||
|
||||
|
||||
26
fastanime/ensure_desktop_icon.py
Normal file
26
fastanime/ensure_desktop_icon.py
Normal file
@@ -0,0 +1,26 @@
|
||||
import os
|
||||
import shutil
|
||||
|
||||
from kivy.utils import platform
|
||||
from pyshortcuts import make_shortcut
|
||||
|
||||
from . import assets_folder
|
||||
|
||||
app = "_ -m fastanime"
|
||||
|
||||
if fastanime := shutil.which("fastanime"):
|
||||
app = fastanime
|
||||
|
||||
|
||||
logo = os.path.join(assets_folder, "logo.png")
|
||||
|
||||
if platform == "win":
|
||||
logo = os.path.join(assets_folder, "logo.ico")
|
||||
|
||||
make_shortcut(
|
||||
app,
|
||||
name="FastAnime",
|
||||
description="Download and watch anime",
|
||||
terminal=False,
|
||||
icon=logo,
|
||||
)
|
||||
@@ -1,6 +1,7 @@
|
||||
from subprocess import Popen, PIPE, DEVNULL
|
||||
import os
|
||||
import threading
|
||||
import shutil
|
||||
|
||||
|
||||
class MPVPlayer:
|
||||
@@ -14,15 +15,17 @@ class MPVPlayer:
|
||||
self.mpv_thread.start()
|
||||
|
||||
def run_mpv(self, url):
|
||||
self.mpv_process = Popen(
|
||||
["mpv", "--input-ipc-server=/tmp/mpvsocket", "--osc", url],
|
||||
stdin=PIPE,
|
||||
stdout=DEVNULL,
|
||||
stderr=DEVNULL,
|
||||
preexec_fn=os.setsid,
|
||||
)
|
||||
self.mpv_process.wait()
|
||||
self.mpv_process = None
|
||||
mpv = shutil.which("mpv")
|
||||
if mpv:
|
||||
self.mpv_process = Popen(
|
||||
[mpv, "--input-ipc-server=/tmp/mpvsocket", "--osc", url],
|
||||
stdin=PIPE,
|
||||
stdout=DEVNULL,
|
||||
stderr=DEVNULL,
|
||||
preexec_fn=os.setsid,
|
||||
)
|
||||
self.mpv_process.wait()
|
||||
self.mpv_process = None
|
||||
|
||||
def send_command(self, command):
|
||||
if self.mpv_process:
|
||||
|
||||
4
setup.py
4
setup.py
@@ -5,6 +5,7 @@ from setuptools import find_packages, setup
|
||||
|
||||
assert sys.version_info >= (3, 10, 0), "FastAnime requires python 3.10+"
|
||||
|
||||
|
||||
path = os.path.abspath(".")
|
||||
|
||||
kv_file_paths = []
|
||||
@@ -49,12 +50,13 @@ if __name__ == "__main__":
|
||||
"kivymd @ https://github.com/kivymd/KivyMD/archive/master.zip",
|
||||
"ffpyplayer",
|
||||
"yt-dlp",
|
||||
"pyshortcuts",
|
||||
],
|
||||
setup_requires=[],
|
||||
python_requires=">=3.10",
|
||||
entry_points={
|
||||
"gui_scripts": [
|
||||
"fastanime = fastanime.__main__:get_hook_dirs",
|
||||
"fastanime = fastanime.__main__:run_app",
|
||||
],
|
||||
},
|
||||
)
|
||||
|
||||
Reference in New Issue
Block a user