Metadata-Version: 2.1
Name: repo-parser
Version: 0.0.1
Summary: A library for extracting metadata out of a source repository.
Author-email: William Lachance <wlach@protonmail.com>
Description-Content-Type: text/markdown
Classifier: License :: OSI Approved :: MIT License
Requires-Dist: GitPython
Project-URL: Home, https://github.com/wlach/repo-parser

# repo-parser

This is a set of python scripts and tools for extracting metadata and structure
out of a monorepo, for the purposes of generating a service registry, unified documentation, or other types of data out of the contents.

It should be considered an experiment, rather than production software. It is inspired by my experiences in the software industry and being frustrated with current solutions being some combination of:

- Expensive
- Time consuming to configure and maintain
- Requiring the specification of redundant metadata (which is bound to get out of date)

Assumptions:

- The files you want to process fit into memory
- You don't care about history

You can see a demo of a documentation site generated from this repo at:

https://repo-parser-demo.netlify.app/

## Local development

You can experiment with the local demo by running `make example`.
It should live-reload as you make changes in the `example/repo` directory.

For other tasks, look at the (very simple) `Makefile` in the root directory.

