Skip to content

Latest commit

 

History

History
146 lines (83 loc) · 4.22 KB

readme.md

File metadata and controls

146 lines (83 loc) · 4.22 KB
Raw

🎨 SE8-Reader

By GPT-4o + Claude + ME🧑‍💻

📖 Overview

This project is an adult comic downloader that promises to provide access to a wide range of mature content. Dive in and explore responsibly!

✨Note: There are daily release updates for new comics through the Github Actions workflow. And the zip file password is the release date in the format YYYY-MM-DD.

🐳 Quick Use

Ensure that you have Docker and Docker Compose installed and Docker is running.

git clone https://github.com/s045pd/SE8-Reader.git
cd SE8-Reader
docker-compose -f docker-compose-quick.yml up

After a short wait, open your browser and visit http://127.0.0.1:8000.

Log in with the default credentials admin:admin.

Then, click on the “Start Find Books” button in the top left corner to begin scraping.

OR ~

🛠️ Installation

First, ensure you have Python installed on your system. Then, clone the repository and navigate to the project directory:

git clone <repository-url>
cd <project-directory>

Install the necessary dependencies with pip:

pip install -r requirements.txt

⚙️ Configuration

Adjust the settings in SE8/settings.py to suit your preferences. Key configurations include:

Database: Ensure your database settings are correctly configured. Middleware: Check and modify any middleware components if needed.

🚀 Running the Project

To run the project locally, use the following command:

python manage.py runserver

Access the project in your browser at http://127.0.0.1:8000/.

🌀 Starting Celery

To ensure background tasks run smoothly, you need to start Celery. Use the following command to start the Celery worker:

celery -A SE8 worker --loglevel=info

Additionally, start the Celery beat scheduler to handle periodic tasks:

celery -A SE8 beat --loglevel=info

🖥️ Usage

This project is automated, minimizing manual input. Here are the main actions:

  1. Start Finding Books

    • Use the "Start Find Books" button at the top to initiate the book-finding process.

  2. Books Management

    • View the list of books under the "Books" section in the navigation panel.
    • Actions: Use the dropdown menu to select actions for managing books, such as updating or deleting entries.
    • Read: Click the "Read" button next to a book title to view its episodes.

  3. Apps Management

    • Navigate through the various sections like Books, Episodes, Images, and Tags under the "APPS" menu.

    • Each section allows you to perform specific actions related to the management of comics content.

  4. Filter and Search

    • Use the search bar to quickly find specific books or episodes.

    • Apply tags from the right sidebar to filter content based on different categories.

🛠️ Actions from admin.py

Based on the admin.py file, here are the actions you can perform:

  • get_images: Fetches images for the selected books.

  • convert_to_pdf: Converts the selected books to PDF format.

  • convert_to_pdf_force: Forcefully converts the selected books to PDF, even if they already exist.

  • refresh_images: Refreshes the images for the selected books.

🐳 Using Docker

To run the project using Docker, follow these steps:

Build and Run the Docker Image:

Use the provided docker_image_rebuild.sh script to build the Docker image and start the container:

export USE_SQLITE=True && bash docker_image_rebuild.sh

This script will stop any running containers, build a new Docker image, and start the new container, making the project accessible at http://127.0.0.1:8000/.

Configuration:

Ensure you have configured your .env file properly. Note that using SQLite (USE_SQLITE) may have performance issues.

📜 License

This project is licensed under the MIT License. See the LICENSE file for details.

📛 Disclaimer

This project is for educational purposes only. If any conflicts of interest arise, please contact us to resolve or close the project.

🙏 Acknowledgments

Special thanks to GPT-4o+Claude for their invaluable contributions and witty insights.

We welcome any new ideas and suggestions from the community. Thank you for your support!

Let the comic adventures begin! 🎉