mymagic 0.0.1__tar.gz

mymagic-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 digipodium
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mymagic-0.0.1/PKG-INFO

@@ -0,0 +1,171 @@
+Metadata-Version: 2.4
+Name: mymagic
+Version: 0.0.1
+Summary: This is a test library
+License: MIT
+License-File: LICENSE
+Author: Mohammad Mubassir
+Author-email: triplem656@gmail.com
+Maintainer: Mohammad Mubassir
+Maintainer-email: triplem656@gmail.com
+Requires-Python: >=3.10,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: requests (>=2.32.5,<3.0.0)
+Project-URL: Documentation, https://digipodium.github.io/dputils/
+Project-URL: Homepage, https://digipodium.github.io/dputils/
+Project-URL: Repository, https://github.com/digipodium/dputils
+Description-Content-Type: text/markdown
+
+
+
+<img alt="Python Version" src="https://img.shields.io/badge/python-3.8+-blue"> <img alt="Contributions welcome" src="https://img.shields.io/badge/contributions-welcome-brightgreen.svg"> <img alt="License" src="https://img.shields.io/badge/license-MIT-green"> <img alt="Build Status" src="https://img.shields.io/badge/build-passing-brightgreen.svg">
+
+<img alt="Documentation Status" src="https://img.shields.io/badge/documentation-up%20to%20date-brightgreen.svg"> <img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dm/dputils"> <img alt="Stars" src="https://img.shields.io/github/stars/digipodium/dputils?style=social">
+
+
+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:
+
+```shell
+pip install dputils
+```
+
+For Mac/Linux users:
+
+```shell
+pip3 install dputils
+```
+
+# Files Module
+
+Functions from dputils.files:
+for now, the files module has two functions:
+
+1. get_data:
+   - To import, use statement:
+      ```python3
+      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:
+      ```python3
+      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:
+      ```python3
+      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:**
+
+```python
+from dputils.scrape import Scraper, Tag
+```
+
+2. **Initialize the `Scraper` class with the URL of the webpage you want to scrape:**
+
+```python
+url = "https://www.example.com"
+scraper = Scraper(url)
+```
+
+3. **Define the tags you want to scrape using the `Tag` class:**
+
+```python
+title_tag = Tag(name='h1', cls='title', output='text')
+price_tag = Tag(name='span', cls='price', output='text')
+```
+
+4. **Extract data from the page:**
+
+```python
+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:**
+
+```python
+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.
+```python
+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:**
+
+```python
+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!

mymagic-0.0.1/mymagic/__init__.py

@@ -0,0 +1,7 @@
+__version__ = '0.0.1'
+
+'''
+mymagic
+~~~~~~~
+    
+'''

mymagic-0.0.1/mymagic/core.py

@@ -0,0 +1,4 @@
+import requests
+
+def testme():
+    print('its working')

mymagic-0.0.1/pyproject.toml

@@ -0,0 +1,20 @@
+[tool.poetry]
+name = "mymagic"
+version = "0.0.1"
+description = "This is a test library"
+authors = ["Mohammad Mubassir <triplem656@gmail.com>"]
+maintainers = ["Mohammad Mubassir <triplem656@gmail.com>"]
+readme = "readme.md"
+license = "MIT"
+
+homepage = "https://digipodium.github.io/dputils/"
+repository = "https://github.com/digipodium/dputils"
+documentation = "https://digipodium.github.io/dputils/"
+
+[tool.poetry.dependencies]
+python = "^3.10"
+requests = "^2.32.5"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"

mymagic-0.0.1/readme.md

@@ -0,0 +1,147 @@
+
+
+<img alt="Python Version" src="https://img.shields.io/badge/python-3.8+-blue"> <img alt="Contributions welcome" src="https://img.shields.io/badge/contributions-welcome-brightgreen.svg"> <img alt="License" src="https://img.shields.io/badge/license-MIT-green"> <img alt="Build Status" src="https://img.shields.io/badge/build-passing-brightgreen.svg">
+
+<img alt="Documentation Status" src="https://img.shields.io/badge/documentation-up%20to%20date-brightgreen.svg"> <img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dm/dputils"> <img alt="Stars" src="https://img.shields.io/github/stars/digipodium/dputils?style=social">
+
+
+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:
+
+```shell
+pip install dputils
+```
+
+For Mac/Linux users:
+
+```shell
+pip3 install dputils
+```
+
+# Files Module
+
+Functions from dputils.files:
+for now, the files module has two functions:
+
+1. get_data:
+   - To import, use statement:
+      ```python3
+      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:
+      ```python3
+      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:
+      ```python3
+      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:**
+
+```python
+from dputils.scrape import Scraper, Tag
+```
+
+2. **Initialize the `Scraper` class with the URL of the webpage you want to scrape:**
+
+```python
+url = "https://www.example.com"
+scraper = Scraper(url)
+```
+
+3. **Define the tags you want to scrape using the `Tag` class:**
+
+```python
+title_tag = Tag(name='h1', cls='title', output='text')
+price_tag = Tag(name='span', cls='price', output='text')
+```
+
+4. **Extract data from the page:**
+
+```python
+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:**
+
+```python
+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.
+```python
+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:**
+
+```python
+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!