Metadata-Version: 2.4
Name: hozint-apiclient
Version: 0.1.0
Summary: Package to communicate with the HOZINT API
Author-email: Thomas Roehr <roehr@simula.no>
Maintainer-email: Thomas Roehr <roehr@simula.no>
License: 3-Clause BSD License / New BSD License
        
        Copyright (c) 2023-2025 Simula Research Laboratory, Oslo, Norway
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
        list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
        this list of conditions and the following disclaimer in the documentation
        and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its contributors
        may be used to endorse or promote products derived from this software without
        specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
        ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
        WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: homepage, https://ai4copsec.github.io/hozint-apiclient
Project-URL: documentation, https://ai4copsec.github.io/hozint-apiclient
Project-URL: repository, https://github.com/ai4copsec/hozint-apiclient
Keywords: open source intelligence,REST API,data processing
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Development Status :: 3 - Alpha
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: License :: OSI Approved :: BSD License
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: pydantic
Requires-Dist: pydantic-settings
Requires-Dist: requests
Requires-Dist: tqdm
Provides-Extra: dp
Requires-Dist: damast; extra == "dp"
Provides-Extra: dev
Requires-Dist: flake8-gl-codeclimate; extra == "dev"
Requires-Dist: isort; extra == "dev"
Requires-Dist: jupyter-book<2; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: pydot; extra == "dev"
Requires-Dist: sphinx-autoapi<=3.3; extra == "dev"
Requires-Dist: tox; extra == "dev"
Provides-Extra: test
Requires-Dist: damast; extra == "test"
Requires-Dist: coverage; extra == "test"
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-console-scripts; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: pytest-timeout; extra == "test"
Requires-Dist: pydot; extra == "test"
Requires-Dist: tox; extra == "test"
Dynamic: license-file

# HOZINT API Client

An Python REST APIClient to query the [HOZINT API](https://www.hozint.com/application-programming-interface).


## Usage

Set up an .env file with the credentials for your HOZINT API subscription.

```
HOZINT_APICLIENT_USER="your@domain.org"
HOZINT_APICLIENT_PASSWORD="yourpassword"
HOZINT_APICLIENT_CSRF_TOKEN="your-selected-csrf-token"
```

To query the api and download the respective reports into a subfolder (by default ./reports):
```
$>hozint-apiclient query --from-time 2026-04-18 --output-dir reports
```

## Testing

Install the project and use the predefined default test environment:

    pytest tests

## Contributing

This project is open to contributions. For details on how to contribute please check the [Contribution Guidelines](https://github.com/ai4copsec/hozint-apiclient/blob/main/CONTRIBUTING.md)


## License
This project is licensed under the [BSD-3-Clause License](https://github.com/ai4copsec/hozint-apiclient/blob/main/LICENSE).

## Copyright

Copyright (c) 2026 [Simula Research Laboratory, Oslo, Norway](https://www.simula.no/research/research-departments)

## Acknowledgments

The development of this library is part of the EU-project [AI4COPSEC](https://ai4copsec.eu) which receives funding from the Horizon Europe framework programme under Grant Agreement N. 101190021.
