https://github.com/dgasmith/reporec

Records GitHub and Conda statistics for funding agencies and general metrics.
https://github.com/dgasmith/reporec

Last synced: 4 months ago
JSON representation

Records GitHub and Conda statistics for funding agencies and general metrics.

• Host: GitHub
• URL: https://github.com/dgasmith/reporec
• Owner: dgasmith
• License: bsd-3-clause
• Created: 2018-10-27T18:35:28.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-03-21T12:53:04.000Z (about 7 years ago)
• Last Synced: 2025-04-19T09:18:26.528Z (about 1 year ago)
• Language: Python
• Homepage:
• Size: 69.3 KB
• Stars: 5
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
reporec

==============================

[//]: # (Badges)

[![Travis Build Status](https://travis-ci.com/dgasmith/reporec.png)](https://travis-ci.com/dgasmith/reporec)

[![codecov](https://codecov.io/gh/dgasmith/reporec/branch/master/graph/badge.svg)](https://codecov.io/gh/dgasmith/reporec/branch/master)

Records GitHub statistics for information and funding agencies.

## Installation

Clone this repository and install with `pip install .`.

## Usage

1. Write a YAML file (e.g. `yourrepos.yaml`) using the same format as the files in `examples/`. Currently `reporec` can access statistics from GitHub repositories and conda packages.

2. If you need access to GitHub statistics, get a GitHub API [Personal Access token](https://github.com/settings/tokens). `reporec`'s token requires full access to the `repo` category and subcategories. Export the GitHub API token to your shell environment with `export GITHUB_TOKEN=`

3. Run `reporec yourrepos.yaml` to generate reports. A directory `rrdata` will be created in the current working directory, containing CSV reports named like `-.csv`.

4. Consider running `reporec` regularly to track statistics over time!

### Copyright

Copyright (c) 2018, Daniel G. A. Smith

#### Acknowledgements

Project based on the

[Computational Molecular Science Python Cookiecutter](https://github.com/molssi/cookiecutter-cms)