Skip to content

Commit b6fc317

Browse files
committed
Added test stubs, doc stubs, and badges in README.md
1 parent d889b89 commit b6fc317

File tree

6 files changed

+745
-27
lines changed

6 files changed

+745
-27
lines changed
+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
2+
# GitHub Actions workflow to generate a requirements.txt, for all the
3+
# automatic processing that GitHub does, from a Poetry setup file, and
4+
# commit the requirements.txt to the repo
5+
#
6+
# Author: lumbroso@cs.princeton.edu
7+
# See GitHub documentation: https://git.io/JJL7O
8+
9+
name: "Update dependency file"
10+
11+
on:
12+
push:
13+
paths:
14+
- 'pyproject.*'
15+
- 'poetry.lock'
16+
17+
jobs:
18+
dependency-update:
19+
name: dependency-update
20+
runs-on: ubuntu-latest
21+
steps:
22+
- name: Checking out latest version of master branch
23+
uses: actions/checkout@master
24+
25+
- name: Setup Python & Poetry and install project
26+
uses: abatilo/actions-poetry@v1.5.0
27+
with:
28+
python_version: 3.8.0
29+
poetry_version: 1.0
30+
working_directory: "." # optional, defaults to ".'
31+
args: install
32+
33+
- name: Generate requirements.txt
34+
uses: abatilo/actions-poetry@v1.5.0
35+
with:
36+
python_version: 3.8.0
37+
poetry_version: 1.0
38+
working_directory: "."
39+
args: export -f requirements.txt --without-hashes > requirements.txt
40+
41+
- name: Generate requirements-dev.txt
42+
uses: abatilo/actions-poetry@v1.5.0
43+
with:
44+
python_version: 3.8.0
45+
poetry_version: 1.0
46+
working_directory: "."
47+
args: export --dev -f requirements.txt --without-hashes > requirements-dev.txt
48+
49+
- name: Commit generated requirements.txt
50+
uses: EndBug/add-and-commit@v4
51+
with:
52+
message: "Commit updated requirements for GH dependency graph + rtd.io"
53+
add: "requirements*.txt"
54+
cwd: "."
55+
force: true
56+
env:
57+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/main.yml

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
2+
on: ["push", "pull_request"]
3+
4+
# Running tests with pytest in Python 3.8
5+
name: pytest
6+
jobs:
7+
pytest:
8+
name: pytest
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@master
12+
13+
- name: Setup Python & Poetry and install project
14+
uses: abatilo/actions-poetry@v1.5.0
15+
with:
16+
python_version: 3.8.0
17+
poetry_version: 1.0
18+
working_directory: "." # optional, defaults to ".'
19+
args: install
20+
21+
- name: Run pytest
22+
uses: abatilo/actions-poetry@v1.5.0
23+
with:
24+
python_version: 3.8.0
25+
poetry_version: 1.0
26+
working_directory: "."
27+
args: run python -m pytest --cov=imslp --cov-branch tests/
28+
29+
- name: Run codecov to upload report to site
30+
uses: abatilo/actions-poetry@v1.5.0
31+
with:
32+
python_version: 3.8.0
33+
poetry_version: 1.0
34+
working_directory: "."
35+
args: run codecov -t ${{ secrets.CODECOV_TOKEN }}

README.md

+7
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# imslp
22

3+
![pytest](https://github.com/jlumbroso/imslp/workflows/pytest/badge.svg)
4+
[![codecov](https://codecov.io/gh/jlumbroso/imslp/branch/master/graph/badge.svg?token=GX52420WN4)](https://codecov.io/gh/jlumbroso/imslp)
5+
[![Documentation Status](https://readthedocs.org/projects/imslp/badge/?version=latest)](https://imslp.readthedocs.io/en/latest/?badge=latest)
6+
[![Downloads](https://pepy.tech/badge/imslp)](https://pepy.tech/project/imslp)
7+
[![Run on Repl.it](https://repl.it/badge/github/jlumbroso/imslp)](https://repl.it/github/jlumbroso/imslp)
8+
[![Stargazers](https://img.shields.io/github/stars/jlumbroso/imslp?style=social)](https://github.com/jlumbroso/imslp)
9+
310
🎼 The clean and modern way of accessing IMSLP data and scores programmatically. 🎶
411

512
## Installation

0 commit comments

Comments
 (0)