Throne3d / 2epub-various-ruby

A scraper of various glowfic collections
1 stars 0 forks source link

README

This README should document the steps necessary to setup this project in order to run the "2epub-various" script.

What is this repository for?

The "2epub-various" script, converted to use the Ruby language. It hopefully downloads the necessary chapters from dreamwidth.org appropriate to load the stories for Effulgence and Incandescence, as well as the miscellaneous related sandboxes, glowfics, pixiethreads, Marri's index, Radon Absinthe, the Peterverse index, Maggie's index and various other things, then generates an epub (or a 'report', or an HTML mirror, or outputs to a local Constellation Rails copy) for them.

How do I get set up?

What can I do?

The different 'processes' are outlined in do_various.rb in the code, and include: do, which downloads the data for a group, epubdo, which basically does do and then output_epub, and repdo, which basically does do and then output_report.

The different 'groups' are outlined in scraper_utils.rb, in FIC_NAME_MAPPING. For example, efful maps to effulgence. The TOC pages are listed below in FIC_TOCS, and they are individually handled in handlers_indexes.rb depending on how the index is formatted.

Pass as a parameter, to do_various.rb, a 'process' followed by a 'group', preferably separated by a space but it might work with other separators. For example, to do a report for the daily report (repdo as a process, report as a group), run do_various.rb repdo report – in the Ubuntu Terminal, at least, you do this by navigating to this directory (2epub-various-ruby) and then executing the command ./do_various.rb repdo report.

How do I fix issues with the sandbox?

There should no longer be any issues with the sandbox! The old issue, which was an inability to navigate around a "discretion advised" message, should now be fixed by using a thing called Mechanize.

Who do I talk to?

If you have a problem, try contacting @Throne3d or another contributor to the project. Running this project is probably not for those without any programming or computing experience.