Skip to content

Commit de61336

Browse files
emmanuelfonsecaemmanuelfonseca
authored
Merge pull request #72 from CHIMEFRB/71-repository-updates
71 repository updates
2 parents 18f2459 + 7825971 commit de61336

10 files changed

Lines changed: 2040 additions & 156 deletions

File tree

‎.github/workflows/cd.yml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Continuous Deployment
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
jobs:
9+
deployment:
10+
runs-on: ubuntu-latest
11+
steps:
12+
-
13+
name: Create release
14+
id: release-please
15+
uses: google-github-actions/release-please-action@v3
16+
with:
17+
release-type: python
18+
package-name: fitburst

‎.github/workflows/ci.yml‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
paths-ignore:
6+
- 'docs/**'
7+
branches: [ main ]
8+
pull_request:
9+
paths-ignore:
10+
- 'docs/**'
11+
branches:
12+
- '**'
13+
14+
jobs:
15+
pre-commit-checks:
16+
runs-on: ubuntu-latest
17+
steps:
18+
-
19+
name: Checkout Repository
20+
uses: actions/checkout@v3
21+
-
22+
name: Install Poetry
23+
run: pipx install poetry
24+
-
25+
name: Setup Python
26+
uses: actions/setup-python@v4
27+
with:
28+
python-version: 3.8
29+
cache: 'poetry'
30+
-
31+
name: Install Dependencies
32+
run: poetry install
33+
-
34+
name: Run Pre-Commit
35+
run: poetry run pre-commit run --all-files --show-diff-on-failure
36+
37+
tests:
38+
needs: pre-commit-checks
39+
runs-on: ubuntu-latest
40+
steps:
41+
-
42+
name: Checkout Repository
43+
uses: actions/checkout@v3
44+
-
45+
name: Install Poetry
46+
run: pipx install poetry
47+
-
48+
name: Setup Python
49+
uses: actions/setup-python@v4
50+
with:
51+
python-version: 3.8
52+
cache: 'poetry'
53+
-
54+
name: Install Dependencies
55+
run: poetry install
56+
57+
- name: Run Tests
58+
run: |
59+
poetry run pytest

‎.github/workflows/tests.yml‎

Lines changed: 0 additions & 45 deletions
This file was deleted.

‎.pre-commit-config.yaml‎

Lines changed: 97 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,98 @@
11
repos:
2-
3-
- repo: https://github.com/pycqa/isort
4-
rev: 5.5.4
5-
hooks:
6-
- id: isort
7-
args: [ --multi-line=3, --trailing-comma, --force-grid-wrap=0, --use-parentheses, --line-width=88]
8-
9-
- repo: https://gitlab.com/pycqa/flake8
10-
rev: 3.8.4
11-
hooks:
12-
- id: flake8
13-
additional_dependencies: ["flake8-eradicate==0.4.0"]
14-
args: [--max-line-length=89]
15-
16-
17-
- repo: https://github.com/asottile/pyupgrade
18-
rev: v2.7.2
19-
hooks:
20-
- id: pyupgrade
21-
args: [--py36-plus]
22-
23-
- repo: https://github.com/psf/black
24-
rev: 20.8b1
25-
hooks:
26-
- id: black
27-
28-
- repo: https://github.com/pre-commit/mirrors-mypy
29-
rev: v0.782
30-
hooks:
31-
- id: mypy
32-
args: [--ignore-missing-imports]
33-
34-
- repo: https://github.com/pycqa/pydocstyle
35-
rev: 4.0.0 # pick a git hash / tag to point to
36-
hooks:
37-
- id: pydocstyle
38-
args: [--convention=numpy, --add-ignore=D104]
39-
40-
- repo: https://github.com/asottile/blacken-docs
41-
rev: v1.8.0
42-
hooks:
43-
- id: blacken-docs
44-
additional_dependencies: [black==20.8b1]
45-
46-
- repo: https://github.com/pre-commit/pre-commit-hooks
47-
rev: v3.2.0
48-
hooks:
49-
- id: trailing-whitespace
50-
exclude: ^docs/*
51-
- id: end-of-file-fixer
52-
exclude: ^docs/*
53-
- id: debug-statements
54-
- id: check-case-conflict
55-
- id: check-json
56-
- id: check-yaml
57-
- id: mixed-line-ending
58-
- id: check-toml
59-
- id: pretty-format-json
60-
- id: check-docstring-first
61-
- id: check-symlinks
62-
- id: detect-private-key
2+
- hooks:
3+
- args:
4+
- --multi-line=3
5+
- --trailing-comma
6+
- --force-grid-wrap=0
7+
- --use-parentheses
8+
- --line-width=88
9+
- --ensure-newline-before-comments
10+
id: isort
11+
repo: https://github.com/pycqa/isort
12+
rev: 5.12.0
13+
- hooks:
14+
- args:
15+
- --max-line-length=89
16+
- --max-complexity=15
17+
id: flake8
18+
repo: https://github.com/pycqa/flake8
19+
rev: 6.1.0
20+
- hooks:
21+
- args:
22+
- --py36-plus
23+
id: pyupgrade
24+
repo: https://github.com/asottile/pyupgrade
25+
rev: v3.10.1
26+
- hooks:
27+
- id: black
28+
repo: https://github.com/psf/black
29+
rev: 23.7.0
30+
- hooks:
31+
- additional_dependencies:
32+
- types-attrs
33+
- types-requests
34+
- types-setuptools
35+
- types-PyYAML
36+
- types-toml
37+
args:
38+
- --ignore-missing-imports
39+
- --no-implicit-optional
40+
id: mypy
41+
repo: https://github.com/pre-commit/mirrors-mypy
42+
rev: v1.5.1
43+
- hooks:
44+
- args:
45+
- --convention=google
46+
- --add-ignore=D104
47+
id: pydocstyle
48+
repo: https://github.com/pycqa/pydocstyle
49+
rev: 6.3.0
50+
- hooks:
51+
- id: blacken-docs
52+
repo: https://github.com/asottile/blacken-docs
53+
rev: 1.16.0
54+
- hooks:
55+
- id: trailing-whitespace
56+
- id: end-of-file-fixer
57+
- id: debug-statements
58+
- id: check-case-conflict
59+
- id: check-json
60+
- id: check-added-large-files
61+
- id: check-yaml
62+
- id: mixed-line-ending
63+
- id: check-toml
64+
- id: pretty-format-json
65+
- id: check-docstring-first
66+
- id: check-symlinks
67+
- id: detect-private-key
68+
- id: pretty-format-json
69+
args:
70+
- --autofix
71+
repo: https://github.com/pre-commit/pre-commit-hooks
72+
rev: v4.4.0
73+
- hooks:
74+
- args:
75+
- -iii
76+
- -lll
77+
id: bandit
78+
repo: https://github.com/PyCQA/bandit
79+
rev: 1.7.5
80+
- hooks:
81+
- additional_dependencies:
82+
- radon
83+
args:
84+
- cc
85+
- --min=C
86+
- --total-average
87+
entry: radon
88+
id: radon
89+
language: python
90+
name: radon
91+
verbose: true
92+
repo: local
93+
- hooks:
94+
- id: commitizen
95+
stages:
96+
- commit-msg
97+
repo: https://github.com/commitizen-tools/commitizen
98+
rev: 3.6.0

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
fitburst
22
========
33

4-
This repo contains functions and objects for modeling dynamic spectra of dispersed astrophysical signals at radio frequencies.
4+
This repo contains functions and objects for modeling dynamic spectra of dispersed astrophysical signals at radio frequencies.
55

66
## Installation
77

88
Currently, `fitburst` can be installed by cloning the repo and running `pip` in the following way:
99

10-
```
10+
```
1111
pc> git clone git@github.com:CHIMEFRB/fitburst.git
1212
pc> cd fitburst
1313
pc/fitburst> pip install . # add the --user option if you're looking to install in your local environment.

‎mkdocs.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,12 +71,12 @@ nav:
7171
- Home: index.md
7272
- About: about.md
7373
- Installation: installation.md
74-
- Usage:
74+
- Usage:
7575
- Ways to Use fitburst: usage/using_fitburst.md
7676
- Format of Input Data: usage/formatting_data_generic.md
7777
- Working with Data Readers: usage/using_data_readers.md
7878
- Creating Models of Spectra: usage/creating_models.md
79-
- Developer Guide:
79+
- Developer Guide:
8080
- Coding Philosophy: developer_guide/philosophy.md
8181
- Package Structure: developer_guide/package_structure.md
8282
- Writing Data Readers: developer_guide/readers.md

0 commit comments

Comments
 (0)