Skip to content

mara-org/dalil

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Dalil

Local proof builder for student projects.

Dalil is a small local CLI that turns a student project folder and a short brief into useful proof: a CV bullet, GitHub pitch, LinkedIn/X posts, gap checklist, and next steps before sharing in Arabic or English.

No API. No cloud upload. No database. No LLM.

Demo

Dalil demo

Install

python3 -m pip install -e .

Later, if the package earns it:

pip install dalil

Quick Start

Create a dalil.json brief inside your project:

{
  "name": "Campus Queue Tracker",
  "audience": "students waiting for university services",
  "problem": "students waste time waiting without knowing if a service desk is crowded",
  "solution": "show a simple queue status, expected wait, and last update time",
  "role": "designed the workflow, built the prototype, and wrote the documentation",
  "proof": "tested the flow with sample queue data and generated a working report",
  "impact": "made the wait visible before a student walks across campus",
  "stack": ["Python", "CLI", "JSON"]
}

Run:

dalil .

Arabic output:

dalil . --lang ar

Run without installing:

PYTHONPATH=src python3 -m dalil examples --brief examples/dalil.json
PYTHONPATH=src python3 -m dalil examples --brief examples/dalil-ar.json --lang ar

Output Formats

dalil . --format text
dalil . --format json --output dalil-report.json
dalil . --lang ar --output dalil-ar.txt

Checks

Dalil inspects simple repo signals like README, tests, license, examples, source languages, frameworks, and entry points, then combines those signals with the student brief.

Dalil gives each project a proof score from 0 to 100. It rewards a clear brief, README, tests, license, examples, detected source code, specific proof, and clear before/after impact. It penalizes missing brief fields, vague problem statements, undocumented proof, and missing tests, license, examples, or source code.

Development

python3 -m unittest discover -s tests
python3 -m compileall src tests
python3 -m pip wheel . -w /tmp/dalil-wheel

Scope

Dalil does not write the project for the student or invent fake impact. It helps turn real project work into a clearer story and points out what is missing before the student posts, applies, or shares the repo.

About

Maintained by mara. Created by gqnxx.

About

Student project proof builder for Mara internal review.

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages