Skip to content

Commit

Permalink
Merge branch 'main' into 411-improve-readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sylvaincom authored Oct 9, 2024
2 parents 1d023e0 + 28e83a4 commit 9b4f55b
Show file tree
Hide file tree
Showing 14 changed files with 420 additions and 392 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Discord server
url: https://discord.gg/SCknzSQW
url: https://discord.gg/scBZerAGwW
about: Developers and users can be found on the Discord server
12 changes: 6 additions & 6 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,20 @@ updates:
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
interval: "monthly"
commit-message:
prefix: "chore(github-actions dependencies):"
prefix: "chore(dependencies): GITHUB-ACTIONS"

- package-ecosystem: "npm"
directory: "/"
schedule:
interval: "weekly"
interval: "monthly"
commit-message:
prefix: "chore(npm dependencies):"
prefix: "chore(dependencies): NPM"

- package-ecosystem: "pip"
directory: "/"
schedule:
interval: "weekly"
interval: "monthly"
commit-message:
prefix: "chore(pip dependencies):"
prefix: "chore(dependencies): PIP"
8 changes: 7 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
name: CI

on: [pull_request]
on:
pull_request:
push:
branches:
- main

jobs:
changes:
Expand All @@ -11,6 +15,7 @@ jobs:
permissions:
pull-requests: read
steps:
- uses: actions/checkout@v4
- uses: dorny/paths-filter@v3
id: filter
with:
Expand Down Expand Up @@ -47,6 +52,7 @@ jobs:

ci-all-green:
needs:
- changes
- lint-all-files
- lint-and-test-skore
- lint-and-test-skore-ui
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ jobs:
path: skore/dist/

publish:
name: Publish package distributions to TestPyPI using trusted publisher
name: Publish package distributions to PyPI using trusted publisher
runs-on: ubuntu-latest
environment: release
permissions:
Expand All @@ -78,7 +78,7 @@ jobs:
name: python-package-distributions
path: dist/

- name: Publish package distributions to TestPyPI
- name: Publish package distributions to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
with:
verify-metadata: false
Expand Down
6 changes: 6 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,18 @@ pip-compile:
python -m piptools compile --extra=tools --output-file=skore/requirements-tools.txt skore/pyproject.toml

install-skore:
cp LICENSE skore/LICENSE
cp README.md skore/README.md

python -m pip install \
-e skore/ \
-r skore/requirements.txt \
-r skore/requirements-test.txt \
-r skore/requirements-tools.txt

rm skore/LICENSE
rm skore/README.md

pre-commit install

build-skore-ui:
Expand Down
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 👋 Welcome to skore

![ci](https://github.com/probabl-ai/skore/actions/workflows/ci.yml/badge.svg)
![ci](https://github.com/probabl-ai/skore/actions/workflows/ci.yml/badge.svg?event=push)
![python](https://img.shields.io/badge/python-3.11%20|%203.12-blue?style=flat&logo=python)

`skore` allows data scientists to create tracking and visualization from their Python code:
Expand All @@ -24,6 +24,7 @@ pip install -U skore
```

## 🚀 Quick start
=======

In your shell, run the following to create a project file `project.skore` (the default) in your current working directory:
```bash
Expand Down Expand Up @@ -92,4 +93,4 @@ Brought to you by:

<a href="https://probabl.ai" target="_blank">
<img width="120" src="https://sylvaincom.github.io/files/probabl/logo_probabl.svg" alt="Probabl logo">
</a>
</a>
Loading

0 comments on commit 9b4f55b

Please sign in to comment.