Skip to main content

A library for extracting metadata out of a source repository.

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

repo_parser-0.0.2.tar.gz (4.3 kB view hashes)

Uploaded Source

Built Distribution

repo_parser-0.0.2-py2.py3-none-any.whl (5.5 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page