Jami Scrapi

A command-line tool for web scraping, designed for ease of use and flexibility. It leverages bimbimba to provide a straightforward interface for extracting data from websites.

Installation

Ensure you have Bun installed. If not, you can install it following the instructions on the Bun website.

bun install -g jami-scrapi

Or

npx jami-scrapi

Or

bunx jami-scrapi

Usage

After installation, you can run the jami-scrapi command in your terminal.

jami-scrapi

The CLI will then prompt you to:

1. Select a library: Choose the scraping library you want to use. Currently uses bimbimba.
2. Select a function: Choose the specific scraping function you want to run from the selected library.
3. Enter a start page: Specify the page number to begin scraping from.
4. Enter an end page: Specify the page number to stop scraping at.

The scraped data will be saved to a JSON file in the current directory, named according to the library and function used (e.g., library_function_name.json).

Example:

jami-scrapi

? Select library:  exampleScraper
? Select function: getPage
? Enter page to start at: 1
? Enter page to end at: 5

This will scrape pages 1 through 5 using the getPage function from the exampleScraper library and save the results to example_scraper_get_page.json.

Requirements

• Node.js v23.0.0+

Contributing

Contributions are welcome! Feel free to submit pull requests or open issues to suggest improvements or report bugs.

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them with descriptive messages.
4. Push your changes to your fork.
5. Submit a pull request to the main branch of the original repository.

License

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