Skip to content

Commit

Permalink
Merge pull request #11 from NoahSchiro/v0.1.1
Browse files Browse the repository at this point in the history
Update name
  • Loading branch information
NoahSchiro authored Aug 18, 2024
2 parents 8a8c0f3 + f06d84d commit 1e24bd8
Show file tree
Hide file tree
Showing 14 changed files with 30 additions and 30 deletions.
4 changes: 2 additions & 2 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
[package]
name = "osm-graph"
name = "osmgraph"
authors = ["NoahSchiro"]
version = "0.1.0"
version = "0.1.1"
edition = "2021"

readme = "README.md"
license = "MIT"

description = "Convert OSM queries into graphs."
#documentation = "todo!" This will not be available until we publish
repository = "https://github.com/NoahSchiro/osm-graph"
repository = "https://github.com/NoahSchiro/osmgraph"

keywords = ["map", "api", "graph", "data-structure"]
categories = ["api-bindings", "data-structures"]
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# osm-graph
# OSMGraph

![Example of A* path on Manhattan](./assets/manhattan_example.png)

![Tests](https://github.com/NoahSchiro/osm-graph/actions/workflows/ci.yml/badge.svg)
![Tests](https://github.com/NoahSchiro/osmgraph/actions/workflows/ci.yml/badge.svg)

`osm-graph` is a crate for quickly fetching data from OpenStreetMap (OSM) and formatting this data
`osmgraph` is a crate for quickly fetching data from OpenStreetMap (OSM) and formatting this data
into a graph data structure that can be used for various computer science tasks and problems.

[OpenStreetMap](https://www.openstreetmap.org/) is a free wiki world map. All of the data is
Expand All @@ -31,8 +31,8 @@ as A*) for free.
### Example

```rust
use osm_graph::graph::{OSMGraph, create_graph};
use osm_graph::overpass_api::{OverpassResponse, osm_request_blocking};
use osmgraph::graph::{OSMGraph, create_graph};
use osmgraph::overpass_api::{OverpassResponse, osm_request_blocking};

use serde_json::Value;

Expand Down
2 changes: 1 addition & 1 deletion assets/test.json

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions examples/astar.rs
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
use std::collections::HashSet;
use std::error::Error;

use osm_graph::overpass_api::{OverpassResponse, osm_request_blocking};
use osm_graph::graph::{OSMGraph, OSMNode, OSMEdge, create_graph};
use osmgraph::overpass_api::{OverpassResponse, osm_request_blocking};
use osmgraph::graph::{OSMGraph, OSMNode, OSMEdge, create_graph};

use serde_json::Value;
use petgraph::graph::{Edge, NodeIndex};
Expand Down
4 changes: 2 additions & 2 deletions examples/parse_graph.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
use std::error::Error;

use osm_graph::overpass_api::{OverpassResponse, osm_request_blocking};
use osm_graph::graph::{OSMGraph, OSMNode, OSMEdge, create_graph};
use osmgraph::overpass_api::{OverpassResponse, osm_request_blocking};
use osmgraph::graph::{OSMGraph, OSMNode, OSMEdge, create_graph};

use serde_json::Value;
use petgraph::stable_graph::DefaultIx;
Expand Down
4 changes: 2 additions & 2 deletions examples/parse_nodes.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
use osm_graph::overpass_api::OverpassResponse;
use osm_graph::graph::{OSMNode, get_osm_nodes};
use osmgraph::overpass_api::OverpassResponse;
use osmgraph::graph::{OSMNode, get_osm_nodes};

use serde_json::Value;

Expand Down
4 changes: 2 additions & 2 deletions examples/parse_ways.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
use osm_graph::overpass_api::OverpassResponse;
use osm_graph::graph::way::{OSMWay, get_osm_ways};
use osmgraph::overpass_api::OverpassResponse;
use osmgraph::graph::way::{OSMWay, get_osm_ways};

use serde_json::Value;

Expand Down
2 changes: 1 addition & 1 deletion examples/query.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
use osm_graph::overpass_api::{osm_request_blocking, OverpassResponse};
use osmgraph::overpass_api::{osm_request_blocking, OverpassResponse};

use serde_json::Value;

Expand Down
2 changes: 1 addition & 1 deletion examples/save_load.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
use osm_graph::overpass_api::OverpassResponse;
use osmgraph::overpass_api::OverpassResponse;

fn main() {

Expand Down
6 changes: 3 additions & 3 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//! `osm-graph` is a crate for quickly fetching data from OpenStreetMap (OSM) and formatting this data
//! `osmgraph` is a crate for quickly fetching data from OpenStreetMap (OSM) and formatting this data
//! into a graph data structure that can be used for various computer science tasks and problems.
//!
//! [OpenStreetMap](https://www.openstreetmap.org/) is a free wiki world map. All of the data is
Expand All @@ -25,8 +25,8 @@
//! Example of the basic utility of this crate:
//!
//! ```rust
//! use osm_graph::graph::{OSMGraph, create_graph};
//! use osm_graph::overpass_api::{OverpassResponse, osm_request_blocking};
//! use osmgraph::graph::{OSMGraph, create_graph};
//! use osmgraph::overpass_api::{OverpassResponse, osm_request_blocking};
//!
//! use serde_json::Value;
//!
Expand Down
2 changes: 1 addition & 1 deletion src/overpass_api.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ use tokio::{
///
/// Example:
/// ```rust
/// use osm_graph::overpass_api::{OverpassResponse, osm_request_blocking};
/// use osmgraph::overpass_api::{OverpassResponse, osm_request_blocking};
///
/// let query = String::from(r#"
/// [out:json];
Expand Down
4 changes: 2 additions & 2 deletions tests/graph.rs
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#[cfg(test)]
mod create_graph {

use osm_graph::overpass_api::OverpassResponse;
use osm_graph::graph::create_graph;
use osmgraph::overpass_api::OverpassResponse;
use osmgraph::graph::create_graph;

use serde_json::Value;

Expand Down
6 changes: 3 additions & 3 deletions tests/overpass_api.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#[cfg(test)]
mod query {

use osm_graph::overpass_api::{osm_request_blocking, osm_request};
use osmgraph::overpass_api::{osm_request_blocking, osm_request};

#[tokio::test]
async fn query() {
Expand Down Expand Up @@ -49,7 +49,7 @@ mod query {
#[cfg(test)]
mod parse {

use osm_graph::overpass_api::{OverpassResponse, osm_request};
use osmgraph::overpass_api::{OverpassResponse, osm_request};

use serde_json::json;

Expand Down Expand Up @@ -83,7 +83,7 @@ mod parse {
#[cfg(test)]
mod save_load {

use osm_graph::overpass_api::{OverpassResponse, osm_request, osm_request_blocking};
use osmgraph::overpass_api::{OverpassResponse, osm_request, osm_request_blocking};

#[tokio::test]
async fn save_load() {
Expand Down

0 comments on commit 1e24bd8

Please sign in to comment.