Skip to content

Commit 0b1dc6f

Browse files
ZeitsperreZeitsperre
authored
Package and Metadata Cleanup (#297)
## Overview Changes: * Updated ReadTheDocs to use the new mambaforge version (`2022.9`). * Addressed calls in GitHub Action usage that were emitting warnings. * Updated `MANIFEST.in` to include and exclude the relevant files for the source distribution. * Modified the `setup.py` to only include the files necessary in the wheel. * Updated `AUTHORS.rst` to list more contributors. * Removed namespace file (`__init__.py`) from tests to ensure that they aren't treated like an importable package. * Updated pre-commit hooks. * Sorted software requirements for legibility. * Removed Travis-CI shell script. ## Additional Information The next step will be to make this package PEP 517 and PEP 621 compliant. With the package in a better shape, converting the setup files should be easy.
2 parents 5450aa0 + 80d4011 commit 0b1dc6f

30 files changed

+130
-251
lines changed

‎.github/workflows/label.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ on:
1111

1212
jobs:
1313
label:
14-
runs-on: ubuntu-22.04
14+
runs-on: ubuntu-latest
1515
steps:
1616
- uses: actions/labeler@v4
1717
with:

‎.github/workflows/main.yml‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,17 +41,23 @@ jobs:
4141
with:
4242
cache-downloads: true
4343
cache-environment: true
44-
activate-environment: finch
4544
environment-file: environment.yml
4645
create-args: >-
46+
conda
4747
python=${{ matrix.python-version }}
4848
- name: Conda and Mamba versions
4949
run: |
5050
conda --version
5151
echo "micromamba: $(micromamba --version)"
52-
- name: Install and test finch-wps
52+
- name: Install finch-wps
5353
run: |
5454
make develop
55+
- name: Check versions
56+
run: |
57+
conda list
58+
pip check
59+
- name: Run tests
60+
run: |
5561
make start
5662
sleep 2
5763
make test-notebooks

‎.pre-commit-config.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ repos:
7171
- id: blackdoc
7272
additional_dependencies: [ 'black==23.3.0' ]
7373
- repo: https://github.com/python-jsonschema/check-jsonschema
74-
rev: 0.23.3
74+
rev: 0.24.1
7575
hooks:
7676
- id: check-github-workflows
7777
- id: check-readthedocs

‎.readthedocs.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ formats: []
1818
build:
1919
os: ubuntu-22.04
2020
tools:
21-
python: "mambaforge-4.10"
21+
python: "mambaforge-22.9"
2222

2323
conda:
2424
environment: environment-docs.yml

‎AUTHORS.rst‎

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,17 @@
22
Credits
33
=======
44

5-
Development Lead
6-
----------------
5+
Development Leads
6+
-----------------
77

8-
* David Huard <[email protected]>
8+
* David Huard <[email protected]> `@huard <https://github.com/huard>`_
9+
* Pascal Bourgault <[email protected]> `@aulemahal <https://github.com/aulemahal>`_
910

1011
Contributors
1112
------------
1213

13-
* Pascal Bourgault <[email protected]>
14-
* Trevor James Smith <[email protected]>
14+
* David Caron `@davidcaron <https://github.com/davidcaron>`_
15+
* Travis Logan <[email protected]> `@tlogan2000 <https://github.com/tlogan2000>`_
16+
* Trevor James Smith <[email protected]> `@Zeitsperre <https://github.com/Zeitsperre>`_
17+
* Mathieu Provencher `@matprov <https://github.com/matprov>`_
18+
* Long Vu <[email protected]> `@tlvu <https://github.com/tlvu>`_

‎CHANGES.rst‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,18 @@
11
Changes
22
*******
33

4+
0.11.3 (2023-08-23)
5+
===================
6+
* Updated ReadTheDocs to use the new mambaforge version (`2022.9`).
7+
* Addressed calls in GitHub Action usage that were emitting warnings.
8+
* Updated `MANIFEST.in` to include and exclude the relevant files for the source distribution.
9+
* Modified the `setup.py` to only include the files necessary in the wheel.
10+
* Updated `AUTHORS.rst` to list more contributors.
11+
* Removed namespace file (`__init__.py`) from tests to ensure that they aren't treated like an importable package.
12+
* Updated pre-commit hooks.
13+
* Sorted software requirements for legibility.
14+
* Removed Travis-CI shell script.
15+
416
0.11.2 (2023-07-27)
517
===================
618
* Added a Docker-based testing suite to the GitHub Workflows.

‎MANIFEST.in‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,20 @@
11
include Makefile
22
include *.txt
33
include *.rst
4-
recursive-include finch *
4+
5+
recursive-include finch *.py
6+
recursive-include finch/processes/modules *.yml
7+
8+
recursive-include tests *.py *.cfg
9+
recursive-include tests/data *.nc *.json *.zip
10+
recursive-include docs Makefile *.rst *.py *.ipynb
11+
12+
recursive-exclude build *
13+
recursive-exclude _build *
14+
recursive-exclude docs/source/notebooks/.ipynb_checkpoints *.ipynb
15+
16+
exclude docs/source/finch*.rst
17+
exclude docs/source/modules.rst
18+
519
global-exclude __pycache__
620
global-exclude *.py[co]

‎Makefile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ help:
4141
install:
4242
@echo "Installing application ..."
4343
@-bash -c 'pip install -e .'
44-
@echo "\nStart service with \`make start'"
44+
@echo "Start service with \`make start'"
4545

4646
.PHONY: develop
4747
develop:

‎docs/source/notebooks/dap_subset.ipynb‎

Lines changed: 8 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,7 @@
1515
{
1616
"cell_type": "code",
1717
"execution_count": 1,
18-
"metadata": {
19-
"execution": {
20-
"iopub.execute_input": "2023-06-02T19:35:06.595739Z",
21-
"iopub.status.busy": "2023-06-02T19:35:06.594965Z",
22-
"iopub.status.idle": "2023-06-02T19:35:09.133584Z",
23-
"shell.execute_reply": "2023-06-02T19:35:09.132717Z"
24-
}
25-
},
18+
"metadata": {},
2619
"outputs": [],
2720
"source": [
2821
"import os\n",
@@ -42,14 +35,7 @@
4235
{
4336
"cell_type": "code",
4437
"execution_count": 2,
45-
"metadata": {
46-
"execution": {
47-
"iopub.execute_input": "2023-06-02T19:35:09.136501Z",
48-
"iopub.status.busy": "2023-06-02T19:35:09.136227Z",
49-
"iopub.status.idle": "2023-06-02T19:35:10.385485Z",
50-
"shell.execute_reply": "2023-06-02T19:35:10.384778Z"
51-
}
52-
},
38+
"metadata": {},
5339
"outputs": [
5440
{
5541
"data": {
@@ -507,12 +493,6 @@
507493
"cell_type": "code",
508494
"execution_count": 3,
509495
"metadata": {
510-
"execution": {
511-
"iopub.execute_input": "2023-06-02T19:35:10.419446Z",
512-
"iopub.status.busy": "2023-06-02T19:35:10.419162Z",
513-
"iopub.status.idle": "2023-06-02T19:35:10.431846Z",
514-
"shell.execute_reply": "2023-06-02T19:35:10.431253Z"
515-
},
516496
"tags": [
517497
"nbval-ignore-output"
518498
]
@@ -562,14 +542,7 @@
562542
{
563543
"cell_type": "code",
564544
"execution_count": 4,
565-
"metadata": {
566-
"execution": {
567-
"iopub.execute_input": "2023-06-02T19:35:10.434305Z",
568-
"iopub.status.busy": "2023-06-02T19:35:10.434108Z",
569-
"iopub.status.idle": "2023-06-02T19:35:10.776440Z",
570-
"shell.execute_reply": "2023-06-02T19:35:10.775411Z"
571-
}
572-
},
545+
"metadata": {},
573546
"outputs": [
574547
{
575548
"data": {
@@ -1000,14 +973,7 @@
1000973
{
1001974
"cell_type": "code",
1002975
"execution_count": 5,
1003-
"metadata": {
1004-
"execution": {
1005-
"iopub.execute_input": "2023-06-02T19:35:10.780253Z",
1006-
"iopub.status.busy": "2023-06-02T19:35:10.779708Z",
1007-
"iopub.status.idle": "2023-06-02T19:35:11.305639Z",
1008-
"shell.execute_reply": "2023-06-02T19:35:11.303384Z"
1009-
}
1010-
},
976+
"metadata": {},
1011977
"outputs": [
1012978
{
1013979
"data": {
@@ -1448,14 +1414,7 @@
14481414
{
14491415
"cell_type": "code",
14501416
"execution_count": 6,
1451-
"metadata": {
1452-
"execution": {
1453-
"iopub.execute_input": "2023-06-02T19:35:11.314483Z",
1454-
"iopub.status.busy": "2023-06-02T19:35:11.313780Z",
1455-
"iopub.status.idle": "2023-06-02T19:35:12.066308Z",
1456-
"shell.execute_reply": "2023-06-02T19:35:12.065672Z"
1457-
}
1458-
},
1417+
"metadata": {},
14591418
"outputs": [
14601419
{
14611420
"data": {
@@ -1905,12 +1864,6 @@
19051864
"cell_type": "code",
19061865
"execution_count": 7,
19071866
"metadata": {
1908-
"execution": {
1909-
"iopub.execute_input": "2023-06-02T19:35:12.070160Z",
1910-
"iopub.status.busy": "2023-06-02T19:35:12.068946Z",
1911-
"iopub.status.idle": "2023-06-02T19:35:12.077186Z",
1912-
"shell.execute_reply": "2023-06-02T19:35:12.076534Z"
1913-
},
19141867
"tags": [
19151868
"nbval-ignore-output"
19161869
]
@@ -1934,14 +1887,7 @@
19341887
{
19351888
"cell_type": "code",
19361889
"execution_count": 8,
1937-
"metadata": {
1938-
"execution": {
1939-
"iopub.execute_input": "2023-06-02T19:35:12.080332Z",
1940-
"iopub.status.busy": "2023-06-02T19:35:12.079814Z",
1941-
"iopub.status.idle": "2023-06-02T19:35:12.086850Z",
1942-
"shell.execute_reply": "2023-06-02T19:35:12.086175Z"
1943-
}
1944-
},
1890+
"metadata": {},
19451891
"outputs": [
19461892
{
19471893
"name": "stdout",
@@ -1988,14 +1934,7 @@
19881934
{
19891935
"cell_type": "code",
19901936
"execution_count": 9,
1991-
"metadata": {
1992-
"execution": {
1993-
"iopub.execute_input": "2023-06-02T19:35:12.089477Z",
1994-
"iopub.status.busy": "2023-06-02T19:35:12.089009Z",
1995-
"iopub.status.idle": "2023-06-02T19:35:12.709706Z",
1996-
"shell.execute_reply": "2023-06-02T19:35:12.709141Z"
1997-
}
1998-
},
1937+
"metadata": {},
19991938
"outputs": [
20001939
{
20011940
"data": {
@@ -2449,14 +2388,7 @@
24492388
{
24502389
"cell_type": "code",
24512390
"execution_count": 10,
2452-
"metadata": {
2453-
"execution": {
2454-
"iopub.execute_input": "2023-06-02T19:35:12.712704Z",
2455-
"iopub.status.busy": "2023-06-02T19:35:12.712477Z",
2456-
"iopub.status.idle": "2023-06-02T19:35:14.854114Z",
2457-
"shell.execute_reply": "2023-06-02T19:35:14.852342Z"
2458-
}
2459-
},
2391+
"metadata": {},
24602392
"outputs": [
24612393
{
24622394
"data": {

‎docs/source/notebooks/finch-usage.ipynb‎

Lines changed: 6 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,7 @@
1212
{
1313
"cell_type": "code",
1414
"execution_count": 1,
15-
"metadata": {
16-
"execution": {
17-
"iopub.execute_input": "2023-06-02T19:35:19.080375Z",
18-
"iopub.status.busy": "2023-06-02T19:35:19.080144Z",
19-
"iopub.status.idle": "2023-06-02T19:35:22.068125Z",
20-
"shell.execute_reply": "2023-06-02T19:35:22.067392Z"
21-
}
22-
},
15+
"metadata": {},
2316
"outputs": [],
2417
"source": [
2518
"import os\n",
@@ -44,14 +37,7 @@
4437
{
4538
"cell_type": "code",
4639
"execution_count": 2,
47-
"metadata": {
48-
"execution": {
49-
"iopub.execute_input": "2023-06-02T19:35:22.073512Z",
50-
"iopub.status.busy": "2023-06-02T19:35:22.072057Z",
51-
"iopub.status.idle": "2023-06-02T19:35:22.082037Z",
52-
"shell.execute_reply": "2023-06-02T19:35:22.081268Z"
53-
}
54-
},
40+
"metadata": {},
5541
"outputs": [
5642
{
5743
"name": "stdout",
@@ -123,14 +109,7 @@
123109
{
124110
"cell_type": "code",
125111
"execution_count": 3,
126-
"metadata": {
127-
"execution": {
128-
"iopub.execute_input": "2023-06-02T19:35:22.125379Z",
129-
"iopub.status.busy": "2023-06-02T19:35:22.125094Z",
130-
"iopub.status.idle": "2023-06-02T19:35:25.696864Z",
131-
"shell.execute_reply": "2023-06-02T19:35:25.696188Z"
132-
}
133-
},
112+
"metadata": {},
134113
"outputs": [],
135114
"source": [
136115
"tasmin = \"https://pavics.ouranos.ca/twitcher/ows/proxy/thredds/dodsC/birdhouse/testdata/flyingpigeon/cmip3/tasmin.sresa2.miub_echo_g.run1.atm.da.nc\"\n",
@@ -140,14 +119,7 @@
140119
{
141120
"cell_type": "code",
142121
"execution_count": 4,
143-
"metadata": {
144-
"execution": {
145-
"iopub.execute_input": "2023-06-02T19:35:25.699734Z",
146-
"iopub.status.busy": "2023-06-02T19:35:25.699500Z",
147-
"iopub.status.idle": "2023-06-02T19:35:25.703765Z",
148-
"shell.execute_reply": "2023-06-02T19:35:25.703159Z"
149-
}
150-
},
122+
"metadata": {},
151123
"outputs": [
152124
{
153125
"name": "stdout",
@@ -174,14 +146,7 @@
174146
{
175147
"cell_type": "code",
176148
"execution_count": 5,
177-
"metadata": {
178-
"execution": {
179-
"iopub.execute_input": "2023-06-02T19:35:25.706750Z",
180-
"iopub.status.busy": "2023-06-02T19:35:25.706520Z",
181-
"iopub.status.idle": "2023-06-02T19:35:26.104457Z",
182-
"shell.execute_reply": "2023-06-02T19:35:26.103837Z"
183-
}
184-
},
149+
"metadata": {},
185150
"outputs": [
186151
{
187152
"data": {
@@ -637,14 +602,7 @@
637602
{
638603
"cell_type": "code",
639604
"execution_count": 6,
640-
"metadata": {
641-
"execution": {
642-
"iopub.execute_input": "2023-06-02T19:35:26.107282Z",
643-
"iopub.status.busy": "2023-06-02T19:35:26.107063Z",
644-
"iopub.status.idle": "2023-06-02T19:35:26.146267Z",
645-
"shell.execute_reply": "2023-06-02T19:35:26.145675Z"
646-
}
647-
},
605+
"metadata": {},
648606
"outputs": [
649607
{
650608
"data": {

0 commit comments

Comments
 (0)