opendev
/
pynotedb
Code Issues Proposed changes
RETIRED, Python parser for notedb
4 Commits 1 Branch 0 Tags 386 KiB
Go to file
Richard Ipsum 601bb97b8a Add link to RFC for format 
Change-Id: I7c1029a67559b9df2f83994ff20152a21b5815d5
 		2017-04-06 16:10:02 +01:00
doc/source Initial Cookiecutter Commit. 2017-02-26 21:05:14 +00:00
pynotedb Initial Cookiecutter Commit. 2017-02-26 21:05:14 +00:00
releasenotes Initial Cookiecutter Commit. 2017-02-26 21:05:14 +00:00
.coveragerc Initial Cookiecutter Commit. 2017-02-26 21:05:14 +00:00
.gitignore Initial Cookiecutter Commit. 2017-02-26 21:05:14 +00:00
.gitreview Initial Cookiecutter Commit. 2017-02-26 21:05:14 +00:00
.mailmap Initial Cookiecutter Commit. 2017-02-26 21:05:14 +00:00
.testr.conf Initial Cookiecutter Commit. 2017-02-26 21:05:14 +00:00
CONTRIBUTING.rst Initial Cookiecutter Commit. 2017-02-26 21:05:14 +00:00
HACKING.rst Initial Cookiecutter Commit. 2017-02-26 21:05:14 +00:00
LICENSE Initial Cookiecutter Commit. 2017-02-26 21:05:14 +00:00
MANIFEST.in Initial Cookiecutter Commit. 2017-02-26 21:05:14 +00:00
README.rst Add link to RFC for format 2017-04-06 16:10:02 +01:00
babel.cfg Initial Cookiecutter Commit. 2017-02-26 21:05:14 +00:00
requirements.txt Initial Cookiecutter Commit. 2017-02-26 21:05:14 +00:00
setup.cfg Initial Cookiecutter Commit. 2017-02-26 21:05:14 +00:00
setup.py Initial Cookiecutter Commit. 2017-02-26 21:05:14 +00:00
test-requirements.txt Initial Cookiecutter Commit. 2017-02-26 21:05:14 +00:00
tox.ini Initial Cookiecutter Commit. 2017-02-26 21:05:14 +00:00

README.rst

pynotedb

This will be a python parser for NoteDB. This repository is currently empty.

About NoteDB

NoteDB is a way of organising review content so that it is stored as git objects in the same git repo as the code, originally created by the people at gerrit. See here for more:

https://gerrit.googlesource.com/homepage/+/md-pages/docs/Notedb.md

https://github.com/CodethinkLabs/pynotedb/blob/master/rfc.mkd

This project

This is a WIP python NoteDB parser.

The goal is to make an API that can be used for code review, for cases when teams wish to keep the details of review in the same place as the code. By providing an API for NoteDB specifically, there are multiple benefits, eg: review metadata is preserved if the code is moved and offline code review is possible.

The API itself will provide a pluggable interface for interacting with review metadata, allowing people to more easily extend the ecosystem around code review with custom components, and communicate with existing review systems.

The existing implementations for NoteDB parsers and APIs are in Java and Perl. As python is a popular language, this python version is intended for better interoperability with existing tools written in python.

Features

  • TODO