Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kingakeem/url-graph
A Neo4j project designed to store and manage relationships between URLs
https://github.com/kingakeem/url-graph
cypher database graph graph-database graphdatabase neo4j url webscraping
Last synced: about 8 hours ago
JSON representation
A Neo4j project designed to store and manage relationships between URLs
- Host: GitHub
- URL: https://github.com/kingakeem/url-graph
- Owner: KingAkeem
- Created: 2023-12-04T21:41:17.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2023-12-05T19:00:23.000Z (about 1 year ago)
- Last Synced: 2024-11-05T16:54:55.317Z (about 2 months ago)
- Topics: cypher, database, graph, graph-database, graphdatabase, neo4j, url, webscraping
- Language: Python
- Homepage:
- Size: 14.6 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# URL-Graph
**URL-Graph** is a Neo4j project designed to store and manage relationships between URLs. This graph database allows you to model and query the connections between different web addresses, providing valuable insights into the structure of your web data.
## Introduction
In the world of web data, understanding relationships between URLs is crucial. The **URL-Graph** project leverages the power of Neo4j to create a graph representation of these relationships, enabling easy navigation and analysis.
## Features
- **Graph Database:** Utilize Neo4j's powerful graph database to model and store URL relationships.
- **Cypher Queries:** Leverage the expressive Cypher query language to extract valuable insights from the graph.
## Getting Started
### Prerequisites
Before you begin, ensure you have the following prerequisites installed:
- Neo4j Database [Download Neo4j](https://neo4j.com/download/)
- Python [Download Python](https://www.python.org/downloads/)
### Installation
1. Clone the repository:
```bash
git clone https://github.com/KingAkeem/url-graph.git
```
2. Install dependencies:
```bash
cd url-graph
pip install -r requirements.txt
```
### Configuration (TODO)
Update the configuration file with your Neo4j connection details (config.yml):
```yaml
neo4j:
uri: bolt://localhost:7687
username: your-username
password: your-password
```
### Running the application
3. Start the Neo4j database, this will be based on the OS that you're using. Check Neo4j instructions for further explanation.
4. Execute the application
```bash
python main.py -u https://www.example.com -d 3 # -u/--url to specify URI and -d/--depth to specify depth of graph
```
Will dockerize project at some point.
## Access the Neo4j Browser or use Cypher queries to interact with the URL graph.
Browser URL: http://localhost:7474/browser/
```cypher
// Example Cypher Query to find relationships for a specific URL
MATCH (n:Node {url: 'https://example.com'})
-[relationship:parent]-()
RETURN n, relationship;
```
## Examples
### With a depth of 1
### With a depth of 3
