Skip to content

Latest commit

 

History

History
55 lines (36 loc) · 1.35 KB

README.md

File metadata and controls

55 lines (36 loc) · 1.35 KB

{{project-name}}

A crate containing Djanco queries.

This crate... TODO

Djanco

Djanco is a query system for querying GitHub datasets downloaded by Parasite as part of the CodeDJ project.

Running the queries

To generate a harness for executing the queries in this crate install cargo-djanco:

cargo install --git https://github.com/PRL-PRG/cargo-djanco

Then, generate the harness:

cargo djanco

This generates s source file src/bin/djanco.rs, which you can run to execute all your queries:

cargo run --bin djanco --release -- --dataset-path DATASET_LIVES_HERE --output-path WRITE_RESULTS_HERE 

Template

The template file for the {{project-name}} crate comes from here.

To create a new crate from the template, first install cargo-generate:

cargo install cargo-generate

Then, use the generate command in cargo to create a new crate from the template:

cargo generate --git https://github.com/PRL-PRG/djanco-query-template --name my-query-crate

Then you can add your query functions. There's an example function in src/lib.rs to get you started.