# funcspy - Functions to help you develop any program or script you want
## Functions for the main technologies
* Functions for your any project with **Python**, for any moments
* Functions for send emails easly with **Outlook** and **Gmail**
* Functions for used in your **GUI** with **Tkinter**
* Functions for use in your projects with **Openai**
* Functions most used in projects with **PDF**, exemple, **OCR**
* Functions for auxiliary in your projects with **Selenium** and **BeautifulSoup**
## Instalation
`pip install -U funcspy`
### Libraryes instalated automaticaly
* selenium
* bs4
* requests
* html5lib
* webdriver-manager
* pretty-html-table
* xlsxwriter
* pandas
* sqlalchemy
* rich
* pyinstaller
* filetype
* pytesseract
* tqdm
* pillow
* PyMuPDF
* holidays
* numpy==1.26.0
## Example of using some of the most important functions
### Emails
#### Example Usage of `send_email_gmail` Function
Below is an example of how to use the `send_email_gmail` function to send an email with multiple recipients and attachments.
```python
from funcspy.emails_funcs.emails_funcs import send_email_gmail
# Email settings
email_app_google = "your_email@gmail.com"
passwd_app_gmail = "your_app_password"
emails_to = ["recipient1@example.com", "recipient2@example.com"]
subject = "Email subject"
body_msg = "Email body in HTML format"
# Attachments (optional)
attachments = ["path/to/file1.pdf", "path/to/file2.docx"]
# Send the email
send_email_gmail(email_app_google, passwd_app_gmail, emails_to, subject, body_msg, attachments)
```
#### Example Usage of `send_email_outlook` Function
Below is an example of how to use the `send_email_outlook` function to send an email with Outlook, including options for recipients, subject, HTML body, attachments, and embedding a DataFrame.
```python
from funcspy.emails_funcs.emails_funcs import send_email_outlook
# Email settings
to = ["recipient1@example.com", "recipient2@example.com"]
subject = "E-mail Subject"
body = "<p>Hello!</p>"
# Attachments (optional)
attachments = ["path/to/file1.pdf", "path/to/file2.docx"]
# DataFrame to be embedded in email body (optional)
# Example format: [df, 'theme_on_pretty_html_table']
send_dateframe_on_body = False # Set to [dataframe, 'theme'] if using pretty_html_table
# Send the email
send_email_outlook(to, subject, body, attachments, send_dateframe_on_body)
```
### GUI
#### Example Usage of `show_popup` Function
Below is an example of how to use the `show_popup` function to display a popup window with a specified title and message text.
```python
from funcspy.gui_funcs.gui_funcs import show_popup
# Popup settings
title = "Popup Title"
text = "This is the message displayed in the popup."
# Show the popup
show_popup(title, text)
```
### OpenAI (GPT/DALL-E/Whisper)
#### Example Usage of `api_chat_completions` Function
Below is an example of how to use the `api_chat_completions` function to send a chat completion request to the OpenAI API.
```python
from funcspy.openai_funcs.openai_funcs import api_chat_completions
# API settings
api_key = 'your_api_key'
model = 'gpt-4-turbo'
messages = [
{"role": "system", "content": "You are a helpful assistant."},
{"role": "user", "content": "Who won the world series in 2020?"},
{"role": "assistant", "content": "The Los Angeles Dodgers won the World Series in 2020."},
{"role": "user", "content": "Where was it played?"}
]
# Send the request
response = api_chat_completions(api_key, model, messages)
print(response)
```
#### Example Usage of `api_image_generation` Function
Below is an example of how to use the `api_image_generation` function to generate images via the OpenAI API.
```python
from funcspy.openai_funcs.openai_funcs import api_image_generation
# API settings
api_key = 'your_api_key'
model = 'dall-e-3'
prompt = 'a photograph of an astronaut riding a horse'
size = '1024x1024'
quality = 'standard'
# Send the request
response = api_image_generation(api_key, prompt, model, size, quality)
print(response)
```
#### Example Usage of `api_vision` Function
Below is an example of how to use the `api_vision` function to process images and answer questions about them using GPT-4 Turbo with Vision.
```python
from funcspy.openai_funcs.openai_funcs import api_vision
# API settings
api_key = 'your_api_key'
model = 'gpt-4-turbo'
messages = {
"role": "user",
"content": [
{"type": "text", "text": "What’s in this image?"},
{
"type": "image_url",
"image_url": {
"url": "https://upload.wikimedia.org/wikipedia/commons/thumb/d/dd/Gfp-wisconsin-madison-the-nature-boardwalk.jpg/2560px-Gfp-wisconsin-madison-the-nature-boardwalk.jpg",
},
},
],
}
# Send the request
response = api_vision(api_key, messages, model)
print(response)
```
#### Example Usage of `api_audio_transcription` Function
Below is an example of how to use the `api_audio_transcription` function to transcribe audio using the OpenAI API.
```python
from funcspy.openai_funcs.openai_funcs import api_audio_transcription
# API settings
api_key = 'your_api_key'
file_path = 'audio_file.mp3'
model = 'whisper-1'
# Send the request
response = api_audio_transcription(api_key, file_path, model)
print(response)
```
### PDF (OCR/Google Vision/Others)
#### Example Usage of `ocr_tesseract` Function
***It is very important to download the tesseract binaries available in the root of our library on Github***
Below is an example of how to use the `ocr_tesseract` function to perform OCR on a PDF file using Tesseract with customizable settings.
```python
from funcspy.pdf_funcs.ocr_funcs import ocr_tesseract
# OCR settings
pdf = 'path/to/your_pdf_file.pdf'
dpi = 300
file_output = 'output_filename'
return_text = True
config_tesseract = ''
limit_pages = None
lang = 'eng'
timeout = 120
# Perform OCR on the PDF
result = ocr_tesseract(
pdf=pdf,
dpi=dpi,
file_output=file_output,
return_text=return_text,
config_tesseract=config_tesseract,
limit_pages=limit_pages,
lang=lang,
timeout=timeout
)
# Output the result
print(result)
```
#### Example Usage of `ocr_google_vision` Function
Below is an example of how to use the `ocr_google_vision` function to perform OCR on a PDF file using Google Vision API with customizable settings.
```python
from funcspy.pdf_funcs.ocr_funcs import ocr_google_vision
# OCR settings
pdf = 'path/to/your_pdf_file.pdf'
api_key = 'your_google_api_key'
dpi = 300
file_output = 'output_filename'
return_text = True
limit_pages = None
is_image = False
# Perform OCR on the PDF
result = ocr_google_vision(
pdf=pdf,
api_key=api_key,
dpi=dpi,
file_output=file_output,
return_text=return_text,
limit_pages=limit_pages,
is_image=is_image
)
# Output the result
print(result)
```
#### Example Usage of `make_ocr_in_pdf_offline` Function
Below is an example of how to use the `make_ocr_in_pdf_offline` function to extract text from a PDF file offline. This function only works with PDFs where the text is selectable.
```python
from funcspy.pdf_funcs.ocr_funcs import make_ocr_in_pdf_offline
# OCR settings
path_pdf = 'path/to/your_pdf_file.pdf'
export_from_file_txt = 'output_text_file.txt' # Set to False if you do not want to export to a file
# Perform OCR on the PDF
result = make_ocr_in_pdf_offline(path_pdf, export_from_file_txt)
# Output the result
print(result)
```
#### Example Usage of `extract_pages` Function
Below is an example of how to use the `extract_pages` function to extract a specified number of pages from a PDF file and create a new PDF file.
```python
from funcspy.pdf_funcs.pdfutils.pdfutils import extract_pages
# PDF settings
original_pdf_path = 'path/to/original_pdf_file.pdf'
new_pdf_path = 'path/to/new_pdf_file.pdf'
num_pages = 10 # Number of pages to extract
# Extract pages from the original PDF
extract_pages(original_pdf_path, new_pdf_path, num_pages)
```
#### Example Usage of `split_pdf` Function
Below is an example of how to use the `split_pdf` function to split a PDF file into multiple files based on a specified page interval.
```python
from funcspy.pdf_funcs.pdfutils.pdfutils import split_pdf
# PDF settings
input_path = 'path/to/input_pdf_file.pdf'
output_dir = 'output_split'
interval = 30 # Number of pages in each split PDF
# Split the PDF
split_pdf(input_path, output_dir, interval)
```
#### Example Usage of `text_to_pdf` Function
Below is an example of how to use the `text_to_pdf` function to convert text into a PDF file with specified margins, font, and font size.
```python
from funcspy.pdf_funcs.pdfutils.pdfutils import text_to_pdf
# PDF settings
text = """This is a sample text to be converted into a PDF file.
You can customize the left and bottom margins, font, and font size."""
filename = 'output_text_pdf.pdf'
left_margin = 70
bottom_margin = 40
font = 'Helvetica'
font_size = 12
# Convert text to PDF
text_to_pdf(text, filename, left_margin, bottom_margin, font, font_size)
```
### Utils for any moments
#### Example Usage of `remove_accents` Function
Below is an example of how to use the `remove_accents` function to remove accents from a given text string.
```python
from funcspy.python_funcs.python_funcs import remove_accents
# Text settings
text = "Olá, como você está?"
# Remove accents from text
result = remove_accents(text)
print(result)
```
#### Example Usage of `random_sleep` Function
Below is an example of how to use the `random_sleep` function to pause execution for a random amount of time between specified minimum and maximum values.
```python
from funcspy.python_funcs.python_funcs import random_sleep
# Sleep settings
min_time = 1 # Minimum sleep time in seconds
max_time = 5 # Maximum sleep time in seconds
# Execute random sleep
random_sleep(min_time, max_time)
```
#### Example Usage of `create_dir_in_current_work_dir` Function
Below is an example of how to use the `create_dir_in_current_work_dir` function to create a directory in the current working directory.
```python
from funcspy.python_funcs.python_funcs import create_dir_in_current_work_dir
# Directory settings
dir_name = 'new_directory'
print_value = True
create_directory = True
# Create directory in the current working directory
result = create_dir_in_current_work_dir(dir_name, print_value, create_directory)
print(result)
```
#### Example Usage of `files_with_absolute_file_path` Function
Below is an example of how to use the `files_with_absolute_file_path` function to get a tuple of absolute file paths from a specified directory.
```python
from funcspy.python_funcs.python_funcs import files_with_absolute_file_path
# Directory path
path_dir = 'your_directory'
# Get absolute file paths
result = files_with_absolute_file_path(path_dir)
print(result)
```
#### Example Usage of `download_file_via_link` Function
Below is an example of how to use the `download_file_via_link` function to download a file from a specified link.
```python
from funcspy.python_funcs.python_funcs import download_file_via_link
# Download settings
link = 'https://filesamples.com/samples/document/xlsx/sample3.xlsx'
file_path = 'myplan.xlsx'
directory = 'downloads' # Set to False if no directory is needed
# Download the file
download_file_via_link(link, file_path, directory)
```
#### Example Usage of `take_only_numbers` Function
Below is an example of how to use the `take_only_numbers` function to extract only the numeric characters from a given string.
```python
from funcspy.python_funcs.python_funcs import take_only_numbers
# String with numbers and other characters
string = "2122 asfs 245"
# Extract only numbers
result = take_only_numbers(string)
print(result)
```
#### Example Usage of `read_json` Function
Below is an example of how to use the `read_json` function to read a JSON file and return its contents as a dictionary.
```python
from funcspy.python_funcs.python_funcs import read_json
# JSON file path
file_json = 'path/to/your_file.json'
# Read JSON file
result = read_json(file_json)
print(result)
```
#### Example Usage of `zip_dirs` Function
Below is an example of how to use the `zip_dirs` function to zip multiple directories into a single zip file.
```python
from funcspy.python_funcs.python_funcs import zip_dirs
# Folders to be zipped
folders = ['folder1', 'folder_with_files2', 'folder3']
zip_filename = 'myzip.zip'
# Zip the directories
zip_dirs(folders, zip_filename)
```
#### Example Usage of `log` Function
Below is an example of how to use the `log` function to log messages with various levels, colors, and formats.
```python
from funcspy.python_funcs.python_funcs import log
# Basic log message with color
log('This is an informational message', color='green')
# Log message with color and format
log('This is a formatted message', color='red', format='b')
# Warning level log with custom styling
log('This is a warning message!', level='w', color='yellow on black b i')
# Critical level log
log('Critical error occurred!', level='c', color='red on yellow b i s blink')
# Error level log
log('An error has been encountered', level='e', color='purple')
```
#### Example Usage of `support_long_paths` Function
Below is an example of how to use the `support_long_paths` function to adjust a path for long filename support on Windows.
```python
from funcspy.python_funcs.python_funcs import support_long_paths
# Path settings
dos_path = 'your/very/long/path/to/a/directory/or/file'
encoding = None # Set to specific encoding if needed
# Get long path support
result = support_long_paths(dos_path, encoding)
print(result)
```
#### Example Usage of `humanize_time` Function
Below is an example of how to use the `humanize_time` function to get a human-readable string representing the time elapsed from a given datetime or timestamp.
```python
from funcspy.python_funcs.python_funcs import humanize_time
from datetime import datetime, timedelta
# Time settings
time = datetime.now() - timedelta(days=1, hours=5) # Example: 1 day and 5 hours ago
# Get human-readable time
result = humanize_time(time)
print(result)
```
#### Example Usage of `clean_directory` Function
Below is an example of how to use the `clean_directory` function to delete all contents of a specified directory, with options for handling files with long names and retrying on permission errors.
```python
from funcspy.python_funcs.python_funcs import clean_directory
import os
# Define the directory to clean
directory_to_clean = os.path.join(os.getcwd(), "example_directory")
# Clean the directory with default settings
clean_directory(directory_to_clean)
# Clean the directory with custom settings
clean_directory(directory_to_clean, timeout_for_clear=10, max_attempts=5, support_long_names=True)
```
## References
* [Rich Formatting for Colors](https://chatgpt.com/c/671e9e2b-8e9c-8008-83aa-61459c33d0ef#:~:text=Rich%20Formatting%20for%20Colors)
* [Tesseract OCR](https://github.com/tesseract-ocr/tesseract)
* [Google Vision API](https://cloud.google.com/vision/docs)
# License
MIT License
# Contact
Questions, thanks and even financial help? Just call me on
* Linkedin:
* [in/gabriel-lopes2002](https://www.linkedin.com/in/gabriel-lopes2002/)
Raw data
{
"_id": null,
"home_page": "https://github.com/gabriellopesdesouza2002/funcspy",
"name": "funcspy",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Functions to help you develop any program or script you want",
"author": "Gabriel Lopes de Souza",
"author_email": "gabriellopesdesouza2002@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/c9/78/d480a4697959ff6df22238d673821b651c56c1588ae27653e91fc47ff02f/funcspy-1.1.1.tar.gz",
"platform": null,
"description": "# funcspy - Functions to help you develop any program or script you want\r\n## Functions for the main technologies\r\n\r\n* Functions for your any project with **Python**, for any moments\r\n* Functions for send emails easly with **Outlook** and **Gmail**\r\n* Functions for used in your **GUI** with **Tkinter**\r\n* Functions for use in your projects with **Openai**\r\n* Functions most used in projects with **PDF**, exemple, **OCR**\r\n* Functions for auxiliary in your projects with **Selenium** and **BeautifulSoup**\r\n\r\n## Instalation\r\n\r\n`pip install -U funcspy`\r\n\r\n### Libraryes instalated automaticaly\r\n* selenium\r\n* bs4\r\n* requests\r\n* html5lib\r\n* webdriver-manager\r\n* pretty-html-table\r\n* xlsxwriter\r\n* pandas\r\n* sqlalchemy\r\n* rich\r\n* pyinstaller\r\n* filetype\r\n* pytesseract\r\n* tqdm\r\n* pillow\r\n* PyMuPDF\r\n* holidays\r\n* numpy==1.26.0\r\n\r\n## Example of using some of the most important functions\r\n\r\n### Emails\r\n\r\n#### Example Usage of `send_email_gmail` Function\r\n\r\nBelow is an example of how to use the `send_email_gmail` function to send an email with multiple recipients and attachments.\r\n\r\n```python\r\nfrom funcspy.emails_funcs.emails_funcs import send_email_gmail\r\n\r\n# Email settings\r\nemail_app_google = \"your_email@gmail.com\"\r\npasswd_app_gmail = \"your_app_password\"\r\nemails_to = [\"recipient1@example.com\", \"recipient2@example.com\"]\r\nsubject = \"Email subject\"\r\nbody_msg = \"Email body in HTML format\"\r\n\r\n# Attachments (optional)\r\nattachments = [\"path/to/file1.pdf\", \"path/to/file2.docx\"]\r\n\r\n# Send the email\r\nsend_email_gmail(email_app_google, passwd_app_gmail, emails_to, subject, body_msg, attachments)\r\n\r\n```\r\n\r\n#### Example Usage of `send_email_outlook` Function\r\n\r\nBelow is an example of how to use the `send_email_outlook` function to send an email with Outlook, including options for recipients, subject, HTML body, attachments, and embedding a DataFrame.\r\n\r\n```python\r\nfrom funcspy.emails_funcs.emails_funcs import send_email_outlook\r\n\r\n# Email settings\r\nto = [\"recipient1@example.com\", \"recipient2@example.com\"]\r\nsubject = \"E-mail Subject\"\r\nbody = \"<p>Hello!</p>\"\r\n\r\n# Attachments (optional)\r\nattachments = [\"path/to/file1.pdf\", \"path/to/file2.docx\"]\r\n\r\n# DataFrame to be embedded in email body (optional)\r\n# Example format: [df, 'theme_on_pretty_html_table']\r\nsend_dateframe_on_body = False # Set to [dataframe, 'theme'] if using pretty_html_table\r\n\r\n# Send the email\r\nsend_email_outlook(to, subject, body, attachments, send_dateframe_on_body)\r\n```\r\n\r\n### GUI\r\n\r\n#### Example Usage of `show_popup` Function\r\n\r\nBelow is an example of how to use the `show_popup` function to display a popup window with a specified title and message text.\r\n\r\n```python\r\nfrom funcspy.gui_funcs.gui_funcs import show_popup\r\n\r\n# Popup settings\r\ntitle = \"Popup Title\"\r\ntext = \"This is the message displayed in the popup.\"\r\n\r\n# Show the popup\r\nshow_popup(title, text)\r\n```\r\n\r\n### OpenAI (GPT/DALL-E/Whisper)\r\n\r\n#### Example Usage of `api_chat_completions` Function\r\n\r\nBelow is an example of how to use the `api_chat_completions` function to send a chat completion request to the OpenAI API.\r\n\r\n```python\r\nfrom funcspy.openai_funcs.openai_funcs import api_chat_completions\r\n\r\n# API settings\r\napi_key = 'your_api_key'\r\nmodel = 'gpt-4-turbo'\r\nmessages = [\r\n {\"role\": \"system\", \"content\": \"You are a helpful assistant.\"},\r\n {\"role\": \"user\", \"content\": \"Who won the world series in 2020?\"},\r\n {\"role\": \"assistant\", \"content\": \"The Los Angeles Dodgers won the World Series in 2020.\"},\r\n {\"role\": \"user\", \"content\": \"Where was it played?\"}\r\n]\r\n\r\n# Send the request\r\nresponse = api_chat_completions(api_key, model, messages)\r\nprint(response)\r\n```\r\n\r\n#### Example Usage of `api_image_generation` Function\r\n\r\nBelow is an example of how to use the `api_image_generation` function to generate images via the OpenAI API.\r\n\r\n```python\r\nfrom funcspy.openai_funcs.openai_funcs import api_image_generation\r\n\r\n# API settings\r\napi_key = 'your_api_key'\r\nmodel = 'dall-e-3'\r\nprompt = 'a photograph of an astronaut riding a horse'\r\nsize = '1024x1024'\r\nquality = 'standard'\r\n\r\n# Send the request\r\nresponse = api_image_generation(api_key, prompt, model, size, quality)\r\nprint(response)\r\n```\r\n\r\n#### Example Usage of `api_vision` Function\r\n\r\nBelow is an example of how to use the `api_vision` function to process images and answer questions about them using GPT-4 Turbo with Vision.\r\n\r\n```python\r\nfrom funcspy.openai_funcs.openai_funcs import api_vision\r\n\r\n# API settings\r\napi_key = 'your_api_key'\r\nmodel = 'gpt-4-turbo'\r\nmessages = {\r\n \"role\": \"user\",\r\n \"content\": [\r\n {\"type\": \"text\", \"text\": \"What\u2019s in this image?\"},\r\n {\r\n \"type\": \"image_url\",\r\n \"image_url\": {\r\n \"url\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/d/dd/Gfp-wisconsin-madison-the-nature-boardwalk.jpg/2560px-Gfp-wisconsin-madison-the-nature-boardwalk.jpg\",\r\n },\r\n },\r\n ],\r\n}\r\n\r\n# Send the request\r\nresponse = api_vision(api_key, messages, model)\r\nprint(response)\r\n```\r\n\r\n#### Example Usage of `api_audio_transcription` Function\r\n\r\nBelow is an example of how to use the `api_audio_transcription` function to transcribe audio using the OpenAI API.\r\n\r\n```python\r\nfrom funcspy.openai_funcs.openai_funcs import api_audio_transcription\r\n\r\n# API settings\r\napi_key = 'your_api_key'\r\nfile_path = 'audio_file.mp3'\r\nmodel = 'whisper-1'\r\n\r\n# Send the request\r\nresponse = api_audio_transcription(api_key, file_path, model)\r\nprint(response)\r\n```\r\n\r\n### PDF (OCR/Google Vision/Others)\r\n\r\n#### Example Usage of `ocr_tesseract` Function\r\n\r\n***It is very important to download the tesseract binaries available in the root of our library on Github***\r\n\r\nBelow is an example of how to use the `ocr_tesseract` function to perform OCR on a PDF file using Tesseract with customizable settings.\r\n\r\n```python\r\nfrom funcspy.pdf_funcs.ocr_funcs import ocr_tesseract\r\n\r\n# OCR settings\r\npdf = 'path/to/your_pdf_file.pdf'\r\ndpi = 300\r\nfile_output = 'output_filename'\r\nreturn_text = True\r\nconfig_tesseract = ''\r\nlimit_pages = None\r\nlang = 'eng'\r\ntimeout = 120\r\n\r\n# Perform OCR on the PDF\r\nresult = ocr_tesseract(\r\n pdf=pdf,\r\n dpi=dpi,\r\n file_output=file_output,\r\n return_text=return_text,\r\n config_tesseract=config_tesseract,\r\n limit_pages=limit_pages,\r\n lang=lang,\r\n timeout=timeout\r\n)\r\n\r\n# Output the result\r\nprint(result)\r\n```\r\n\r\n#### Example Usage of `ocr_google_vision` Function\r\n\r\nBelow is an example of how to use the `ocr_google_vision` function to perform OCR on a PDF file using Google Vision API with customizable settings.\r\n\r\n```python\r\nfrom funcspy.pdf_funcs.ocr_funcs import ocr_google_vision\r\n\r\n# OCR settings\r\npdf = 'path/to/your_pdf_file.pdf'\r\napi_key = 'your_google_api_key'\r\ndpi = 300\r\nfile_output = 'output_filename'\r\nreturn_text = True\r\nlimit_pages = None\r\nis_image = False\r\n\r\n# Perform OCR on the PDF\r\nresult = ocr_google_vision(\r\n pdf=pdf,\r\n api_key=api_key,\r\n dpi=dpi,\r\n file_output=file_output,\r\n return_text=return_text,\r\n limit_pages=limit_pages,\r\n is_image=is_image\r\n)\r\n\r\n# Output the result\r\nprint(result)\r\n```\r\n\r\n#### Example Usage of `make_ocr_in_pdf_offline` Function\r\n\r\nBelow is an example of how to use the `make_ocr_in_pdf_offline` function to extract text from a PDF file offline. This function only works with PDFs where the text is selectable.\r\n\r\n```python\r\nfrom funcspy.pdf_funcs.ocr_funcs import make_ocr_in_pdf_offline\r\n\r\n# OCR settings\r\npath_pdf = 'path/to/your_pdf_file.pdf'\r\nexport_from_file_txt = 'output_text_file.txt' # Set to False if you do not want to export to a file\r\n\r\n# Perform OCR on the PDF\r\nresult = make_ocr_in_pdf_offline(path_pdf, export_from_file_txt)\r\n\r\n# Output the result\r\nprint(result)\r\n```\r\n\r\n#### Example Usage of `extract_pages` Function\r\n\r\nBelow is an example of how to use the `extract_pages` function to extract a specified number of pages from a PDF file and create a new PDF file.\r\n\r\n```python\r\nfrom funcspy.pdf_funcs.pdfutils.pdfutils import extract_pages\r\n\r\n# PDF settings\r\noriginal_pdf_path = 'path/to/original_pdf_file.pdf'\r\nnew_pdf_path = 'path/to/new_pdf_file.pdf'\r\nnum_pages = 10 # Number of pages to extract\r\n\r\n# Extract pages from the original PDF\r\nextract_pages(original_pdf_path, new_pdf_path, num_pages)\r\n```\r\n\r\n#### Example Usage of `split_pdf` Function\r\n\r\nBelow is an example of how to use the `split_pdf` function to split a PDF file into multiple files based on a specified page interval.\r\n\r\n```python\r\nfrom funcspy.pdf_funcs.pdfutils.pdfutils import split_pdf\r\n\r\n# PDF settings\r\ninput_path = 'path/to/input_pdf_file.pdf'\r\noutput_dir = 'output_split'\r\ninterval = 30 # Number of pages in each split PDF\r\n\r\n# Split the PDF\r\nsplit_pdf(input_path, output_dir, interval)\r\n```\r\n\r\n#### Example Usage of `text_to_pdf` Function\r\n\r\nBelow is an example of how to use the `text_to_pdf` function to convert text into a PDF file with specified margins, font, and font size.\r\n\r\n```python\r\nfrom funcspy.pdf_funcs.pdfutils.pdfutils import text_to_pdf\r\n\r\n# PDF settings\r\ntext = \"\"\"This is a sample text to be converted into a PDF file.\r\nYou can customize the left and bottom margins, font, and font size.\"\"\"\r\nfilename = 'output_text_pdf.pdf'\r\nleft_margin = 70\r\nbottom_margin = 40\r\nfont = 'Helvetica'\r\nfont_size = 12\r\n\r\n# Convert text to PDF\r\ntext_to_pdf(text, filename, left_margin, bottom_margin, font, font_size)\r\n```\r\n\r\n### Utils for any moments\r\n\r\n#### Example Usage of `remove_accents` Function\r\n\r\nBelow is an example of how to use the `remove_accents` function to remove accents from a given text string.\r\n\r\n```python\r\nfrom funcspy.python_funcs.python_funcs import remove_accents\r\n\r\n# Text settings\r\ntext = \"Ol\u00e1, como voc\u00ea est\u00e1?\"\r\n\r\n# Remove accents from text\r\nresult = remove_accents(text)\r\nprint(result)\r\n```\r\n\r\n#### Example Usage of `random_sleep` Function\r\n\r\nBelow is an example of how to use the `random_sleep` function to pause execution for a random amount of time between specified minimum and maximum values.\r\n\r\n```python\r\nfrom funcspy.python_funcs.python_funcs import random_sleep\r\n\r\n# Sleep settings\r\nmin_time = 1 # Minimum sleep time in seconds\r\nmax_time = 5 # Maximum sleep time in seconds\r\n\r\n# Execute random sleep\r\nrandom_sleep(min_time, max_time)\r\n```\r\n\r\n#### Example Usage of `create_dir_in_current_work_dir` Function\r\n\r\nBelow is an example of how to use the `create_dir_in_current_work_dir` function to create a directory in the current working directory.\r\n\r\n```python\r\nfrom funcspy.python_funcs.python_funcs import create_dir_in_current_work_dir\r\n\r\n# Directory settings\r\ndir_name = 'new_directory'\r\nprint_value = True\r\ncreate_directory = True\r\n\r\n# Create directory in the current working directory\r\nresult = create_dir_in_current_work_dir(dir_name, print_value, create_directory)\r\nprint(result)\r\n```\r\n\r\n#### Example Usage of `files_with_absolute_file_path` Function\r\n\r\nBelow is an example of how to use the `files_with_absolute_file_path` function to get a tuple of absolute file paths from a specified directory.\r\n\r\n```python\r\nfrom funcspy.python_funcs.python_funcs import files_with_absolute_file_path\r\n\r\n# Directory path\r\npath_dir = 'your_directory'\r\n\r\n# Get absolute file paths\r\nresult = files_with_absolute_file_path(path_dir)\r\nprint(result)\r\n```\r\n\r\n#### Example Usage of `download_file_via_link` Function\r\n\r\nBelow is an example of how to use the `download_file_via_link` function to download a file from a specified link.\r\n\r\n```python\r\nfrom funcspy.python_funcs.python_funcs import download_file_via_link\r\n\r\n# Download settings\r\nlink = 'https://filesamples.com/samples/document/xlsx/sample3.xlsx'\r\nfile_path = 'myplan.xlsx'\r\ndirectory = 'downloads' # Set to False if no directory is needed\r\n\r\n# Download the file\r\ndownload_file_via_link(link, file_path, directory)\r\n```\r\n\r\n#### Example Usage of `take_only_numbers` Function\r\n\r\nBelow is an example of how to use the `take_only_numbers` function to extract only the numeric characters from a given string.\r\n\r\n```python\r\nfrom funcspy.python_funcs.python_funcs import take_only_numbers\r\n\r\n# String with numbers and other characters\r\nstring = \"2122 asfs 245\"\r\n\r\n# Extract only numbers\r\nresult = take_only_numbers(string)\r\nprint(result)\r\n```\r\n\r\n#### Example Usage of `read_json` Function\r\n\r\nBelow is an example of how to use the `read_json` function to read a JSON file and return its contents as a dictionary.\r\n\r\n```python\r\nfrom funcspy.python_funcs.python_funcs import read_json\r\n\r\n# JSON file path\r\nfile_json = 'path/to/your_file.json'\r\n\r\n# Read JSON file\r\nresult = read_json(file_json)\r\nprint(result)\r\n```\r\n\r\n#### Example Usage of `zip_dirs` Function\r\n\r\nBelow is an example of how to use the `zip_dirs` function to zip multiple directories into a single zip file.\r\n\r\n```python\r\nfrom funcspy.python_funcs.python_funcs import zip_dirs\r\n\r\n# Folders to be zipped\r\nfolders = ['folder1', 'folder_with_files2', 'folder3']\r\nzip_filename = 'myzip.zip'\r\n\r\n# Zip the directories\r\nzip_dirs(folders, zip_filename)\r\n```\r\n\r\n#### Example Usage of `log` Function\r\n\r\nBelow is an example of how to use the `log` function to log messages with various levels, colors, and formats.\r\n\r\n```python\r\nfrom funcspy.python_funcs.python_funcs import log\r\n\r\n# Basic log message with color\r\nlog('This is an informational message', color='green')\r\n\r\n# Log message with color and format\r\nlog('This is a formatted message', color='red', format='b')\r\n\r\n# Warning level log with custom styling\r\nlog('This is a warning message!', level='w', color='yellow on black b i')\r\n\r\n# Critical level log\r\nlog('Critical error occurred!', level='c', color='red on yellow b i s blink')\r\n\r\n# Error level log\r\nlog('An error has been encountered', level='e', color='purple')\r\n```\r\n\r\n#### Example Usage of `support_long_paths` Function\r\n\r\nBelow is an example of how to use the `support_long_paths` function to adjust a path for long filename support on Windows.\r\n\r\n```python\r\nfrom funcspy.python_funcs.python_funcs import support_long_paths\r\n\r\n# Path settings\r\ndos_path = 'your/very/long/path/to/a/directory/or/file'\r\nencoding = None # Set to specific encoding if needed\r\n\r\n# Get long path support\r\nresult = support_long_paths(dos_path, encoding)\r\nprint(result)\r\n```\r\n\r\n#### Example Usage of `humanize_time` Function\r\n\r\nBelow is an example of how to use the `humanize_time` function to get a human-readable string representing the time elapsed from a given datetime or timestamp.\r\n\r\n```python\r\nfrom funcspy.python_funcs.python_funcs import humanize_time\r\nfrom datetime import datetime, timedelta\r\n\r\n# Time settings\r\ntime = datetime.now() - timedelta(days=1, hours=5) # Example: 1 day and 5 hours ago\r\n\r\n# Get human-readable time\r\nresult = humanize_time(time)\r\nprint(result)\r\n```\r\n\r\n#### Example Usage of `clean_directory` Function\r\n\r\nBelow is an example of how to use the `clean_directory` function to delete all contents of a specified directory, with options for handling files with long names and retrying on permission errors.\r\n\r\n```python\r\nfrom funcspy.python_funcs.python_funcs import clean_directory\r\nimport os\r\n\r\n# Define the directory to clean\r\ndirectory_to_clean = os.path.join(os.getcwd(), \"example_directory\")\r\n\r\n# Clean the directory with default settings\r\nclean_directory(directory_to_clean)\r\n\r\n# Clean the directory with custom settings\r\nclean_directory(directory_to_clean, timeout_for_clear=10, max_attempts=5, support_long_names=True)\r\n```\r\n\r\n## References\r\n\r\n* [Rich Formatting for Colors](https://chatgpt.com/c/671e9e2b-8e9c-8008-83aa-61459c33d0ef#:~:text=Rich%20Formatting%20for%20Colors)\r\n* [Tesseract OCR](https://github.com/tesseract-ocr/tesseract)\r\n* [Google Vision API](https://cloud.google.com/vision/docs)\r\n\r\n# License\r\n\r\nMIT License\r\n\r\n# Contact\r\n\r\nQuestions, thanks and even financial help? Just call me on\r\n\r\n* Linkedin:\r\n * [in/gabriel-lopes2002](https://www.linkedin.com/in/gabriel-lopes2002/)\r\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Functions to help you develop any program or script you want",
"version": "1.1.1",
"project_urls": {
"Homepage": "https://github.com/gabriellopesdesouza2002/funcspy"
},
"split_keywords": [
"functions",
"to",
"help",
"you",
"develop",
"any",
"program",
"or",
"script",
"you",
"want"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c978d480a4697959ff6df22238d673821b651c56c1588ae27653e91fc47ff02f",
"md5": "0ab45a3dfc9e3732a04a1d681c88bc01",
"sha256": "82fbbfc10388d8e2727e26c0dc2e887ae1bbfa4ba8ffdf01c18890b7e1abd0e9"
},
"downloads": -1,
"filename": "funcspy-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "0ab45a3dfc9e3732a04a1d681c88bc01",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 65026,
"upload_time": "2024-11-03T17:56:20",
"upload_time_iso_8601": "2024-11-03T17:56:20.532011Z",
"url": "https://files.pythonhosted.org/packages/c9/78/d480a4697959ff6df22238d673821b651c56c1588ae27653e91fc47ff02f/funcspy-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-03 17:56:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "gabriellopesdesouza2002",
"github_project": "funcspy",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "funcspy"
}
JSON
