https://github.com/haginara/PyCriminalIP

Python library for CriminalIP(https://www.criminalip.io/)
https://github.com/haginara/PyCriminalIP

criminalip python

Last synced: about 1 month ago
JSON representation

Python library for CriminalIP(https://www.criminalip.io/)

• Host: GitHub
• URL: https://github.com/haginara/PyCriminalIP
• Owner: haginara
• License: mit
• Created: 2023-01-12T21:51:31.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-03-06T06:54:17.000Z (10 months ago)
• Last Synced: 2024-11-07T23:58:45.267Z (about 1 month ago)
• Topics: criminalip, python
• Language: Python
• Homepage:
• Size: 44.9 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-ip-search-engines - PyCriminalIP

README

        
# CriminalIP library for Pyhton(unofficial)

Integrated with CriminalIP API with Python.

## Installation

- Install from git

```

git clone https://github.com/haginara/PyCriminalIP.git

cd PyCriminalIP

python setup.py install

```

- Install from pypi

```

pip install pycriminalip

```

## How-to-Use

### Prepare the API Key from Criminalip.io

### Import classes and create an objects

```

import typing

from criminalip import CriminalIP

ip = IP('api_key_from_criminalip_io')

ip_data: dict[str, typing.Any] = ip.data('aispera.com')

print(ip_data)

```

## Development

It requires `pipenv` to manage the requirements. And it also requires make command as optional

```

pipenv install

```

## Unit Testing

```

pipenv run pytest

# or

pipenv run python -m unittest tests.test_CriminalIP

```