digipodium / dputils

open source library from digipodium

A python library which can be used to extraxct data from files, pdfs, doc(x) files, as well as save data into these files. This library can be used to scrape and extract webpage data from websites as well.

Installation Requirements and Instructions

Python versions 3.8 or above should be installed. After that open your terminal: For Windows users:

pip install dputils

For Mac/Linux users:

pip3 install dputils

Files Module

Functions from dputils.files: for now, the files module has two functions:

1. get_data:

   • To import, use statement:

     from dputils.files import get_data

   • Obtains data from files of any extension given as args(supports text files, binary files, pdf, doc for now, more coming!)

   • sample call:

     content = get_data(r"sample.docx")
     print(content)

   • Returns a string or binary data depending on the output arg

   • images will not be extracted

2. save_data:

   • save_data can be used to write and save data into a file of valid extension.
   • sample call:

     from dputils.files import save_data
     
     pdfContent = save_data("sample.pdf", "Sample text to insert")
     print(pdfContent)

   • Returns True if file is successfully accessed and modified. Otherwise, False.

Scrape Module

Data extraction from a page

Here's a basic tutorial to help you get started with the scraper module.

1. Import the required classes and functions:

from dputils.scrape import Scraper, Tag

2. Initialize the Scraper class with the URL of the webpage you want to scrape:

url = "https://www.example.com"
scraper = Scraper(url)

3. Define the tags you want to scrape using the Tag class:

title_tag = Tag(name='h1', cls='title', output='text')
price_tag = Tag(name='span', cls='price', output='text')

4. Extract data from the page:

data = scraper.get_data_from_page(title=title_tag, price=price_tag)
print(data)

Extracting list of items from a page

For more advanced usage, such as extracting repeated data from lists of items on a page, you can use the following approach:

1. Initialize the Scraper class:

url = "https://www.example.com/products"
scraper = Scraper(url)

2. Define the tags for the target section and the items within that section: For repeated data extraction, you need to define Target and item and pass it to get_repeating_data_from_page() method.
   • target - defines the Tag() for area of the page containing the list of items.
   • items - defines the Tag() for repeated items within the target section. Like a product-card in product grid/list.

target_tag = Tag(name='div', cls='product-list')
item_tag = Tag(name='div', cls='product-item')
title_tag = Tag(name='h2', cls='product-title', output='text')
price_tag = Tag(name='span', cls='product-price', output='text')
link_tag = Tag(name='a', cls='product-link', output='href')

1. Extract repeated data from the page:

products = scraper.get_repeating_data_from_page(
    target=target_tag,
    items=item_tag,
    title=title_tag,
    price=price_tag,
    link=link_tag
)
for product in products:
    print(product)

These functions can used on python versions 3.8 or greater.

References for more help: https://digipodium.github.io/dputils/

Contribution

if you want to contribute to this project and make it better, your help is very welcome.

• Fork the project
• Create your feature branch (git checkout -b feature/fooBar)
• Commit your changes (git commit -am 'Add some fooBar')
• Push to the branch (git push origin feature/fooBar)
• Create a new Pull Request
• Wait for your PR to be reviewed and merged
• Star the project if you've found it useful
• Share the project with your friends
• Create an issue if you find a bug or want to request a new feature
• Improve the project by refactoring the code
• Review the PRs of other contributors
• Suggest new features
• Suggest new technologies to be used

Thank you for using dputils!

dputils's Issues

update documentation

Documents need to be updated. Please update it ASAP

The libraries are updated, Please Updated the Documents related to it

Screenshot

Could not save data in correct format in the PDF file

import os
data = ""
folder = 'C:/windows/system32/'
files  = os.listdir(folder)
for item in files:
    fullpath = os.path.join(folder,item)
    if os.path.isfile(fullpath):
        sz = os.path.getsize(fullpath)
        out = f'{item.ljust(70)} | {sz/1024 :.1f} kb'
        data += out + '\n'

then

from dputils import files
files.save_data('dlls.pdf',data)

generated a PDF files but it does not contain correct data

Could not Store info in Docx file

i tested this code

import os
data = ""
folder = 'C:/windows/system32/'
files  = os.listdir(folder)
for item in files:
    fullpath = os.path.join(folder,item)
    if os.path.isfile(fullpath):
        sz = os.path.getsize(fullpath)
        out = f'{item.ljust(70)} | {sz/1024 :.1f} kb'
        data += out + '\n'

and then

from dputils import files
files.save_data('dlls.docx',data)

A Test Issue

This is a test issue for testing the issue