README
¶
metro2
Metro2 is an open-source consumer credit history report for credit report file creation and validation.
Getting Started
Docker Image
You can run our docker image moov/metro2 from Docker Hub or use this repository. No configuration is required to serve on :8080 with metrics in Prometheus format. We also have docker images for OpenShift.
Go Library
There is a Go library which can read and write credit reporting specifications. We write unit tests and fuzz the code to help ensure our code is production ready for everyone. Metro2 uses Go Modules to manage dependencies and suggests Go 1.14 or greater.
To clone our code and verify our tests on your system run:
$ git clone git@github.com:moov-io/metro2.git
$ cd metro2
$ go test ./...
ok github.com/moov-io/metro2 0.710s coverage: 98.1% of statements
Commands
Each interaction that the library supports is exposed in a command-line option:
| Command | Info |
|---|---|
convert |
The convert command allows users to convert from a metro file to another format file. Result will create a metro file. |
print |
The print command allows users to print a metro file with special file format (json, metro). |
validator |
The validator command allows users to validate a metro file. |
web |
The web command will launch a web server with endpoints to management metro files. |
Web server endpoints
| Method | Endpoint | Content-Type | Info |
|---|---|---|---|
POST |
/convert |
multipart/form-data | convert metro file. will download new file. |
GET |
/health |
text/plain | check web server. |
POST |
/print |
multipart/form-data | print metro file. |
POST |
/validator |
multipart/form-data | validate metro file. |
Getting Help
| channel | info |
|---|---|
| Google Group moov-users | The Moov users Google group is for contributors other people contributing to the Moov project. You can join them without a google account by sending an email to moov-users+subscribe@googlegroups.com. After receiving the join-request message, you can simply reply to that to confirm the subscription. |
| Twitter @moov_io | You can follow Moov.IO's Twitter feed to get updates on our project(s). You can also tweet us questions or just share blogs or stories. |
| GitHub Issue | If you are able to reproduce a problem please open a GitHub Issue under the specific project that caused the error. |
| moov-io slack | Join our slack channel (#metro2) to have an interactive discussion about the development of the project. |
Supported and Tested Platforms
- 64-bit Linux (Ubuntu, Debian), macOS, and Windows
Contributing
Yes please! Please review our Contributing guide and Code of Conduct to get started! Checkout our issues for something to help out with.
This project uses Go Modules and uses Go 1.14 or higher. See Golang's install instructions for help setting up Go. You can download the source code and we offer tagged and released versions as well. We highly recommend you use a tagged release for production.
License
Apache License 2.0 See LICENSE for details.
Documentation
Source Files
Directories