ingress.mailman

exception bigbang.ingress.mailman.InvalidURLException(value)

Bases: Exception

bigbang.ingress.mailman.access_provenance(directory)

Return an object with provenance information located in the given directory, or None if no provenance was found.

bigbang.ingress.mailman.collect_archive_from_url(url: Union[list, str], archive_dir='/home/docs/checkouts/readthedocs.org/user_builds/bigbang-py/checkouts/stable/archives/', notes=None)

Collect archives (generally tar.gz) files from mailmain archive page.

Return True if archives were downloaded, False otherwise (for example if the page lists no accessible archive files).

bigbang.ingress.mailman.collect_from_file(urls_file: str, archive_dir: str = '/home/docs/checkouts/readthedocs.org/user_builds/bigbang-py/checkouts/stable/archives/', notes=None)

Collect urls from a file.

bigbang.ingress.mailman.collect_from_url(url: Union[list, str], archive_dir: str = '/home/docs/checkouts/readthedocs.org/user_builds/bigbang-py/checkouts/stable/archives/', notes=None)

Collect data from a given url.

bigbang.ingress.mailman.get_list_name(url)

Return the ‘list name’ from a canonical mailman archive url.

Otherwise return the same URL.

bigbang.ingress.mailman.normalize_archives_url(url)

Normalize url.

will try to infer, find or guess the most useful archives URL, given a URL.

Return normalized URL, or the original URL if no improvement is found.

bigbang.ingress.mailman.open_activity_summary(url, archive_dir='/home/docs/checkouts/readthedocs.org/user_builds/bigbang-py/checkouts/stable/archives/')

Open the message activity summary for a particular mailing list (as specified by url).

Return the dataframe, or return None if no activity summary export file is found.

bigbang.ingress.mailman.populate_provenance(directory, list_name, list_url, notes=None)

Create a provenance metadata file for current mailing list collection.

bigbang.ingress.mailman.recursive_get_payload(x)

Get payloads recursively.

bigbang.ingress.mailman.unzip_archive(url, archive_dir='/home/docs/checkouts/readthedocs.org/user_builds/bigbang-py/checkouts/stable/archives/')

Unzip archive files.

bigbang.ingress.mailman.update_provenance(directory, provenance)

Update provenance file with given object.

bigbang.ingress.mailman.urls_to_collect(urls_file: str)

Collect urls given urls in a file.