Metadata-Version: 2.4
Name: ontolocy
Version: 0.9.3
Summary: A Python package for modeling cybersecurity data in a Neo4j graph database.
Home-page: https://github.com/ontolocy/ontolocy-lib
Author: Ontolocy
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pydantic<3,>=2
Requires-Dist: neontology<3,>=2
Requires-Dist: pandas<3,>=2
Requires-Dist: click<9,>=8
Requires-Dist: xmltodict
Requires-Dist: requests
Requires-Dist: openpyxl
Requires-Dist: PyYAML
Provides-Extra: shodan
Requires-Dist: shodan; extra == "shodan"
Provides-Extra: all
Requires-Dist: shodan; extra == "all"
Dynamic: license-file

# Ontolocy

An open source cyber security graph ontology.

Use Python and Neo4j to explore cyber security data as a graph.

Currently in alpha/proof-of-concept stage - the ontology is likely to change (there may be breaking changes between minor releases).

> "All models are wrong, but some are useful" - George Box

Read the [docs](https://ontolocy.readthedocs.io/)

## Built with Ontolocy

- [Ontolocy Explore](https://explore.ontolocy.com/)

## Quick Start

### Install Ontolocy

```bash
pip install ontolocy
```

### Setup Neo4j Connection Details

Put info in a local `.env` file.

```txt
# .env
NEO4J_URI=neo4j://localhost:7687
NEO4J_USERNAME=neo4j
NEO4J_PASSWORD=Neo4jPassword

NEO4J_AUTH=neo4j/Neo4jPassword      # If running Neo4j with Docker
```

### Import MITRE ATT&CK Data into Neo4j

```bash
ontolocy parse mitre-attack
```
