Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/anned20/begoneads

BeGoneAds is a script that puts some popular hosts file lists into the systems hosts file as a adblocker measure.
https://github.com/anned20/begoneads

adblock adblocker automation click python requests tqdm

Last synced: 12 days ago
JSON representation

BeGoneAds is a script that puts some popular hosts file lists into the systems hosts file as a adblocker measure.

Host: GitHub
URL: https://github.com/anned20/begoneads
Owner: anned20
License: mit
Created: 2019-02-20T21:06:31.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2023-07-30T15:42:15.000Z (over 1 year ago)
Last Synced: 2024-04-26T14:45:23.417Z (7 months ago)
Topics: adblock, adblocker, automation, click, python, requests, tqdm
Language: Python
Homepage:
Size: 22.5 KB
Stars: 311
Watchers: 10
Forks: 15
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

        # BeGoneAds

![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/anned20/begoneads.svg)

![GitHub issues](https://img.shields.io/github/issues/anned20/begoneads.svg)

![GitHub pull requests](https://img.shields.io/github/issues-pr/anned20/begoneads.svg)

![GitHub](https://img.shields.io/github/license/anned20/begoneads.svg)

[![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)](https://www.python.org/)

![Awesome Badges](https://img.shields.io/badge/badges-awesome-green.svg)

BeGoneAds is a script that puts some popular hosts file lists into the systems hosts file as a adblocker measure.

See it working on asciinema:

[![asciicast](https://asciinema.org/a/weDJ7SZw49HBdTl7iB0nWIYgI.svg)](https://asciinema.org/a/weDJ7SZw49HBdTl7iB0nWIYgI)

## Requirements

- Python 3.6 or higher

## Installation instructions

### From PyPI

To install BeGoneAds from PyPI use the following command:

```shell

pip install begoneads

```

### From source

Clone this repository:

```shell

git clone https://github.com/anned20/begoneads.git

```

Install the program:

```shell

python setup.py install

```

## Getting started

You are now ready to use BeGoneAds:

```shell

begoneads

```

You should see something like:

```

Usage: begoneads [OPTIONS] COMMAND [ARGS]...

  Install or uninstall BeGoneAds, the host blocker for the system hosts

  file

Options:

  --help  Show this message and exit.

Commands:

  install    Install or update BeGoneAds

  uninstall  Uninstall BeGoneAds

```

## Usage

To install the hosts to your system hosts file: 

```shell

begoneads install

```

To install the hosts to your system hosts file with custom sources: 

```shell

begoneads install --sources https://www.custom.sources/hosts,http://www.and-another.one/hosts

```

To install the hosts to your system hosts file with local sources: 

```shell

begoneads install --local-sources path/to/hosts/file,other/path

```

The options `sources` and `local-sources` can be used together

To uninstall the hosts to your system hosts file: 

```shell

begoneads uninstall

```

## Sources of hosts data unified in this variant

Updated `hosts` files from the following locations are always unified and

included:

Host file source                  | Home page   |

-----------------                 | :---------: |

Steven Black's ad-hoc list        | [link](https://github.com/StevenBlack/hosts/blob/master/data/StevenBlack/hosts) |

Malware Domain List               | [link](https://www.malwaredomainlist.com/) |

add.Dead                          | [link](https://github.com/FadeMind/hosts.extras) |

add.Spam                          | [link](https://github.com/FadeMind/hosts.extras) |

Dan Pollock                       | [link](https://someonewhocares.org/hosts/) |

MVPS hosts file                   | [link](http://winhelp2002.mvps.org/) |

yoyo.org                          | [link](https://pgl.yoyo.org/adservers/) |

Mitchell Krog's - Badd Boyz Hosts | [link](https://github.com/mitchellkrogza/Badd-Boyz-Hosts) |

CoinBlocker                       | [link](https://gitlab.com/ZeroDot1/CoinBlockerLists) |

UncheckyAds                       | [link](https://github.com/FadeMind/hosts.extras) |

add.2o7Net                        | [link](https://github.com/FadeMind/hosts.extras) |

KADhosts                          | [link](https://github.com/azet12/KADhosts) |

AdAway                            | [link](https://adaway.org/) |

add.Risk                          | [link](https://github.com/FadeMind/hosts.extras) |

## TODO for 1.0.0

- [X] Windows support

- [X] Custom selection of host files

- [X] Setuptools

- [X] Apply own hosts

- [ ] Systemd integration

- [ ] Package it for Debian, Arch, CentOS, Fedora, etc.

## Testing

To run the tests you use [pytest](https://pytest.org)

Execute them with `pytest` in the project directory

## Built with

- [requests](http://docs.python-requests.org/en/master/) - Getting the webpage

- [click](https://github.com/mitsuhiko/click) - Parsing command line options

- [tqdm](https://github.com/tqdm/tqdm) - Showing a fancy progress bar

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details