Twann
55aac48f01
testing / test-unit (push) Successful in 6s
Details
testing / lint (push) Successful in 5s
Details
testing / test-integrity (push) Successful in 4s
Details
|
||
|---|---|---|
| .forgejo/workflows | ||
| .gitea | ||
| debian | ||
| extra | ||
| scripts | ||
| tblock | ||
| test | ||
| .bandit.yml | ||
| .gitignore | ||
| CHANGELOG.md | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| CONTRIBUTORS.md | ||
| LICENSE | ||
| MANIFEST.in | ||
| Makefile | ||
| README.md | ||
| SECURITY.md | ||
| pyproject.toml | ||
| requirements.txt | ||
| setup.cfg | ||
| setup.py | ||
| tblock.spec | ||
README.md
TBlock
Description
TBlock is a free and open-source system-wide ad-blocker that is compatible with most filter list formats.
To view the repository for the graphical user interface, click here.
Installation
You can easily install TBlock with:
pipx install tblock
More installation methods — such as Windows installer and packages for Linux distributions — can be found on the website.
Usage
After installing, you need to setup TBlock in order to enable protection against ads and trackers:
tblock --init
You can learn more by reading the documentation.
Demo
Roadmap
Here is a list of the upcoming changes in TBlock code. Suggestions are, of course, welcome.
- Implement a GUI for TBlock
- Rewrite the entire code, make a clearer public API and publish release 3.0.0
Contributing
Everyone is welcome to contribute to TBlock in different ways. Bug reports can be made directly from the Gitea issue tracker, by sending an email to the team or in our Matrix room.
If you want to suggest a modification in the code, you can open a pull request or send your patch using email or Matrix.
If you want to be a beta-tester, you can install the latest beta version from our release page and contact us to give a feedback.
You can find more information on how to contribute here.
Support
The best way to support is to contribute. If you want, you can also make a donation.
Authors and acknowledgment
TBlock is currently mainained by Twann, who is also its creator. A big thank you to all the people who contribute(d) to the project.
Credits
Here is a list of all libraries used in the project:
| Name | Author | License |
|---|---|---|
| colorama | Jonathan Hartley | BSD |
| requests | Kenneth Reitz | Apache 2.0 |
| urllib3 | Andrey Petrov | MIT |
| argumentor | Twann | LGPLv3 |
It is also worth mentioning pacman, from which TBlock's command-line design is highly inspired.
Contact
License
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.