Metadata-Version: 2.4
Name: banip
Version: 2.2.0
Summary: Create country-focused IP blocklists
Keywords: blocklist,firewall,geolocation,ip-address,security
Author: Peter Nardi
Author-email: Peter Nardi <geozeke@gmail.com>
License-Expression: MIT
License-File: LICENSE
License-File: LICENSE-rich
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: System Administrators
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Security
Classifier: Topic :: System :: Networking :: Firewalls
Classifier: Typing :: Typed
Requires-Dist: requests>=2.32.3
Requires-Dist: rich>=15.0.0
Requires-Dist: ruamel-yaml>=0.19.1
Requires-Python: >=3.12
Project-URL: Homepage, https://github.com/geozeke/banip
Project-URL: Documentation, https://geozeke.github.io/banip/
Project-URL: Repository, https://github.com/geozeke/banip
Project-URL: Issues, https://github.com/geozeke/banip/issues
Project-URL: Changelog, https://github.com/geozeke/banip/blob/main/CHANGELOG.md
Description-Content-Type: text/markdown

# banip

<img
  src="https://raw.githubusercontent.com/geozeke/banip/main/assets/banip-logo.png"
  alt="banip logo"
  width="120"
/>

banip creates country-focused IP blocklists from MaxMind GeoLite2 data,
the ipsum threat-intelligence feed, and user-managed configuration.

It supports macOS, Linux, and native Windows with Python 3.12 or newer.
Windows Subsystem for Linux is optional for running banip and is the
recommended Windows environment for the complete development workflow.

## Documentation

Read the full documentation at <https://geozeke.github.io/banip/>.

It covers installation, configuration, commands, managed bot ranges,
development, and the country-code reference.

## Quick start

```console
uv tool install --managed-python banip
banip database init
banip database update
banip build
```

Upgrade an existing installation with `uv tool upgrade banip`.

For pipx and virtual-environment installation options, see the
[getting-started guide](https://geozeke.github.io/banip/getting-started/).

`banip database update geolite` requires MaxMind credentials. See the
[getting-started guide](https://geozeke.github.io/banip/getting-started/)
for the required account and configuration details.

## Development

```console
just setup
just check
```

See the [development guide](https://geozeke.github.io/banip/development/)
for focused checks, changelog preparation, and release procedures.

## License

banip is released under the MIT license. See [LICENSE](LICENSE).
