Skip to content

Commit 7e568cb

Browse files
committed
Added LICENSE
1 parent a7ca6a6 commit 7e568cb

2 files changed

Lines changed: 40 additions & 18 deletions

File tree

LICENSE

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
BSD 3-Clause License
2+
3+
Copyright (c) 2021--2025, Scientific Python project
4+
All rights reserved.
5+
6+
Redistribution and use in source and binary forms, with or without
7+
modification, are permitted provided that the following conditions are met:
8+
9+
1. Redistributions of source code must retain the above copyright notice, this
10+
list of conditions and the following disclaimer.
11+
12+
2. Redistributions in binary form must reproduce the above copyright notice,
13+
this list of conditions and the following disclaimer in the documentation
14+
and/or other materials provided with the distribution.
15+
16+
3. Neither the name of the copyright holder nor the names of its
17+
contributors may be used to endorse or promote products derived from
18+
this software without specific prior written permission.
19+
20+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
23+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
24+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
26+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
27+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

readme.md

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,13 @@
11
# SPEC 0 Version Action
22

3-
This repository contains a GitHub Action to generate the
3+
This repository contains a GitHub Action to generate the files required for the SPEC-0 documentation.
44

5-
### Drop Schedule
5+
## Using the action
66

7-
Below is an auto generated schedule with recommended dates for dropping support. We suggest that the next release in a given quarter is
8-
considered as the one removing support for a given item.
7+
## Automatically updating dependencies
98

10-
You may want to delay the removal of support of an older Python version until your package fully works on the newly released Python, thus keeping the number of supported minor versions of Python the same for your package.
11-
12-
{{< include-md "schedule.md" >}}
13-
14-
### Automatically updating dependencies
15-
16-
To help projects stay compliant with this spec, we additionally provide a `schedule.json` file that can be used by CI systems to deterime new version boundaries. The structure of the file is as follows:
9+
To help projects stay compliant with this spec, we additionally provide a `schedule.json` file that can be used by CI systems to determine new version boundaries.
10+
The structure of the file is as follows:
1711

1812
```json
1913
[
@@ -26,7 +20,9 @@ To help projects stay compliant with this spec, we additionally provide a `sched
2620
]
2721
```
2822

29-
All information in the json file is in a string format that should be easy to use. The date is the first timestamp of the relevant quarter. Thus a workflow for using this file could be:
23+
All information in the json file is in a string format that should be easy to use.
24+
The date is the first timestamp of the relevant quarter.
25+
Thus a workflow for using this file could be:
3026

3127
1. fetch `schedule.json`
3228
2. determine maximum date that is smaller than current date
@@ -35,21 +31,18 @@ All information in the json file is in a string format that should be easy to us
3531
You can obtain the new versions you should set by using this `jq` expression:
3632

3733
```sh
38-
3934
jq 'map(select(.start_date |fromdateiso8601 |tonumber < now))| sort_by("start_date") | reverse | .[0].packages ' schedule.json
40-
4135
```
4236

4337
If you use a package manager like pixi you could update the dependencies with a bash script like this:
4438

4539
```sh
4640
curl -Ls -o schedule.json https://raw.githubusercontent.com/scientific-python/specs/main/spec-0000/schedule.json
4741
for line in $(jq 'map(select(.start_date |fromdateiso8601 |tonumber < now))| sort_by("start_date") | reverse | .[0].packages | to_entries | map(.key + ":" + .value)[]' --raw-output schedule.json); do
48-
package=$(echo "$line" | cut -d ':' -f 1)
49-
version=$(echo "$line" | cut -d ':' -f 2)
42+
package=$(echo "$line" | cut -d ':' -f 1)
43+
version=$(echo "$line" | cut -d ':' -f 2)
5044
if pixi list -x "^$package" &>/dev/null| grep "No packages" -q; then
51-
pixi add "$package>=$version";
45+
pixi add "$package>=$version";
5246
fi
5347
done
54-
5548
```

0 commit comments

Comments
 (0)