Skip to main content

Chickadee

Yet another IP address enrichment tool.

         _          _
        ('<        >')
       \(_)________( \
        (___________)\\        _____ _     _      _             _
           (     )     \      / ____| |   (_)    | |           | |
            |   |            | |    | |__  _  ___| | ____ _  __| | ___  ___
            |   |            | |    | '_ \| |/ __| |/ / _` |/ _` |/ _ \/ _ \
            |   |            | |____| | | | | (__|   < (_| | (_| |  __/  __/
           _|   |_            \_____|_| |_|_|\___|_|\_\__,_|\__,_|\___|\___|
          (_______)

build status Total alerts Language grade: Python Unit Tests Docstring Coverage Coverage Status MIT Licence PyPI version PyPi downloads DeepSource

Supported IP address resolvers:

Documentation

This project's documentation is available in the docs/ folder, or hosted on GitHub at https://chapinb.com/chickadee/.

Specific documentation:

Known bugs

Below are a list of known bugs. Please report any new bugs identified or submit a PR to patch any of the below or ones you found on your own. No one is perfect :)

  • IPv6 addresses expressed in expanded form in the source document are not properly deduplicated against discovered IPv6 addresses in compressed form.
  • While you can provide multiple input files in the same instance, the IPs are distinct to a single input item. For example, if you provide a file and folder as two inputs to the same invocation, chickadee will dedupe all IPs within the single file, then separately dedupe all IPs within the files in the directory. This means you may have duplicate resolutions in the same output in this case.
  • JSON and CSV output will show column/field names even if a value is not present. Please enter an issue if this does not support your usecase.

Contributing

Please create a fork of the repository, make your changes, and submit a pull request for review!

You can always use the issues tab to suggest features and identify bugs.

Release files for chickadee 20210314.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for chickadee 20210314.1
File Size Uploaded
chickadee-20210314.1.tar.gz 28.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for chickadee 20210314.1
File Interpreter ABI Platform
chickadee-20210314.1-py3-none-any.whl Python 3 none any Details

Total release size: 74.2 kB

Release files / chickadee-20210314.1.tar.gz

Download URL chickadee-20210314.1.tar.gz
Size 28.6 kB
Tags Source
SHA-256 checksum
How to use checksums
070164314b890deb66a0ee06a8d6216792e21e6d7ec92d3f0e5b69121d35dc02
BLAKE2b-256 checksum
How to use checksums
1823e4be73d95d3baeef8873a01636ff3df0f985f6e7d5434af8146474d1145d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.7.3

Release files / chickadee-20210314.1-py3-none-any.whl

Download URL chickadee-20210314.1-py3-none-any.whl
Size 45.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
86607dec5ce7a98dd54837c9afd0ae08da1e825353f58cf2115160ca4ea4f86d
BLAKE2b-256 checksum
How to use checksums
f3807b0f7a59b670eadb1ebd1c72b00a775527b9aa9cdf88145dfe5ffff0e851
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.7.3
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page