advertools

The advertools.extract module provides functions to identify and extract specific structured entities from lists of text. This is useful for analyzing social media content or SEO text to find patterns like hashtags, mentions, or specific linguistic structures.

Available entities for extraction include:

• Hashtags
• Mentions
• Numbers
• Questions
• Emojis

Note: As this is an automated documentation reference, specific function signatures and parameter details are defined within the advertools.extract module members.

advertools is designed around two main principles to make it easy for digital marketers to use:

1. Independent Functions: The package is a collection of independent functions. There are no complex custom data structures to learn. If you understand basic Python and the marketing task at hand, you can use the functions.
2. UNIX Philosophy:
   • Do one thing and do it well: Each function has a specific purpose (e.g., extracting hashtags, crawling websites, or downloading sitemaps).
   • Work together: While functions are independent, they are designed to be used in pipelines for SEO, SEM, and social media analysis.
   • Universal Interface (DataFrames): Most functions return a pandas.DataFrame or a file that can be loaded into one. This allows you to immediately use the results with other data science tools like pandas, Plotly, or machine learning libraries.

The advertools.word_frequency module provides tools for performing text analysis and mining on lists of text. It allows you to calculate word counts on both an absolute basis (raw frequency) and a weighted basis.

Weighted analysis is particularly useful when your text data is accompanied by descriptive statistics such as pageviews, sales, bounces, or sessions. By using these metrics as weights, you can determine which words are most influential or frequent relative to the importance of the text they appear in.

You can access the general documentation for the advertools CLI using the advertools command or its shorthand adv. To see the help menu for a specific command, append --help or -h to that command.

# Get general help
advertools --help
adv -h

# Get help for a specific command (e.g., sitemaps or crawl)
advertools sitemaps --help
adv crawl -h

To keep a record of errors, exceptions, and statistics, pass a file path in a dictionary to the custom_settings parameter.

Best Practice: Use the same name for your output_file and your log file, but with a different file extension, to make retrieving them easier.

To use the advertools Command Line Interface (CLI), install the package using pip. You only need Python 3 installed to use the CLI; no Python programming knowledge is required to run the available commands.

python3 -m pip install advertools