Skip to content

Commit

Permalink
prepare for release
Browse files Browse the repository at this point in the history
  • Loading branch information
hadim committed Nov 3, 2023
1 parent 2bfbc84 commit aa1aeea
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 9 deletions.
10 changes: 5 additions & 5 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -104,11 +104,11 @@ jobs:
- name: Build the wheel and sdist
run: python -m build --no-isolation

# - name: Publish package to PyPI
# uses: pypa/gh-action-pypi-publish@release/v1
# with:
# password: ${{ secrets.PYPI_API_TOKEN }}
# packages-dir: dist/
- name: Publish package to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
with:
password: ${{ secrets.PYPI_API_TOKEN }}
packages-dir: dist/

- name: Create GitHub Release
uses: softprops/action-gh-release@de2c0eb89ae2a093876385947365aca7b0e5f844
Expand Down
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,36 @@

---

[![PyPI](https://img.shields.io/pypi/v/splito)](https://pypi.org/project/splito/)
[![Conda](https://img.shields.io/conda/v/conda-forge/splito?label=conda&color=success)](https://anaconda.org/conda-forge/splito)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/splito)](https://pypi.org/project/splito/)
[![Conda](https://img.shields.io/conda/dn/conda-forge/splito)](https://anaconda.org/conda-forge/splito)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/splito)](https://pypi.org/project/splito/)
[![Code license](https://img.shields.io/badge/Code%20License-Apache_2.0-green.svg)](https://github.com/datamol-io/splito/blob/main/LICENSE)
[![GitHub Repo stars](https://img.shields.io/github/stars/datamol-io/splito)](https://github.com/datamol-io/splito/stargazers)
[![GitHub Repo stars](https://img.shields.io/github/forks/datamol-io/splito)](https://github.com/datamol-io/splito/network/members)

[![test](https://github.com/datamol-io/splito/actions/workflows/test.yml/badge.svg)](https://github.com/datamol-io/splito/actions/workflows/test.yml)
[![release](https://github.com/datamol-io/splito/actions/workflows/release.yml/badge.svg)](https://github.com/datamol-io/splito/actions/workflows/release.yml)
[![code-check](https://github.com/datamol-io/splito/actions/workflows/code-check.yml/badge.svg)](https://github.com/datamol-io/splito/actions/workflows/code-check.yml)
[![doc](https://github.com/datamol-io/splito/actions/workflows/doc.yml/badge.svg)](https://github.com/datamol-io/splito/actions/workflows/doc.yml)

Splito is a machine learning dataset splitting library for life sciences.

## Installation

You can install `splito` using pip:

```bash
pip install splito
```

You can use conda/mamba. Ask @maclandrol for credentials to the conda forge or for a token

```bash
mamba install -c conda-forge splito
```

## Documentation

Find the documentation at <https://splito-docs.datamol.io/>.
Expand Down
10 changes: 7 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,17 @@ Splito is part of the Datamol ecosystem: <https://datamol.io>.

## Installation

Use conda:
You can install `splito` using pip:

```bash
mamba install -c conda-forge splito
pip install splito
```

_**Note:** We highly recommend using a [Conda Python distribution](https://github.com/conda-forge/miniforge) to install Datamol. The package is also pip installable if you need it: `pip install splito`._
You can use conda/mamba. Ask @maclandrol for credentials to the conda forge or for a token

```bash
mamba install -c conda-forge splito
```

## Quick API Tour

Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ site_description: "Splito: Machine Learning dataset splitting for life sciences.
site_url: "https://github.com/datamol-io/splito"
repo_url: "https://github.com/datamol-io/splito"
repo_name: "datamol-io/splito"
copyright: Copyright 2020 - 2023 datamol.io
copyright: Copyright 2023 - 2024 datamol.io

remote_branch: "gh-pages"
use_directory_urls: false
Expand Down

0 comments on commit aa1aeea

Please sign in to comment.