Skip to content

Commit

Permalink
Removed makefile
Browse files Browse the repository at this point in the history
  • Loading branch information
roll committed Dec 7, 2023
1 parent e16ea72 commit 19940a2
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 27 deletions.
10 changes: 0 additions & 10 deletions Makefile

This file was deleted.

4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![Build](https://img.shields.io/github/actions/workflow/status/frictionlessdata/dplib-py/general.yaml?branch=main)](https://github.com/frictionlessdata/dplib-py/actions)
[![Coverage](https://img.shields.io/codecov/c/github/frictionlessdata/dplib-py/main)](https://codecov.io/gh/frictionlessdata/dplib-py)
[![Release](https://img.shields.io/pypi/v/dplib-py.svg)](https://pypi.python.org/pypi/dplib-py)
[![Codebase](https://img.shields.io/badge/codebase-github-brightgreen)](https://github.com/frictionlessdata/dplib-py)
[![Release](https://img.shields.io/pypi/v/dplib-py.svg)](https://pypi.python.org/pypi/dplib-py)

Python implementation of the Data Package standard and various models and utils for working with data.
Python implementation of the Data Package standard and various models and utils for working with data
16 changes: 4 additions & 12 deletions docs/contributing/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,34 +33,26 @@ Now you can setup you IDE to use a proper Python path:
.python/dplib-py/bin/python
```

## Installation

To start working on the project install the dependencies:

```bash
hatch install
```

## Documentation

Documentation is written with Mkdocs (defined in `mkdocs.yaml`). The source articles are in the `docs` directory. To start a live-reload server:

```bash
hatch write
hatch run serve
```

Building the docs:

```bash
hatch docs
hatch run docs
```

## Testing

To run all the checks on the codebase:

```bash
hatch test
hatch run test
```

## Releasing
Expand All @@ -72,5 +64,5 @@ Update the version and initiate the release script:
```bash
# Ensure you're on the up-to-date `main` branch
hatch version <major|minor|micro>
make release
hatch run release
```
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![Build](https://img.shields.io/github/actions/workflow/status/frictionlessdata/dplib-py/general.yaml?branch=main)](https://github.com/frictionlessdata/dplib-py/actions)
[![Coverage](https://img.shields.io/codecov/c/github/frictionlessdata/dplib-py/main)](https://codecov.io/gh/frictionlessdata/dplib-py)
[![Release](https://img.shields.io/pypi/v/dplib-py.svg)](https://pypi.python.org/pypi/dplib-py)
[![Codebase](https://img.shields.io/badge/codebase-github-brightgreen)](https://github.com/frictionlessdata/dplib-py)
[![Release](https://img.shields.io/pypi/v/dplib-py.svg)](https://pypi.python.org/pypi/dplib-py)

Python implementation of the Data Package standard and various models and utils for working with data
17 changes: 15 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,19 @@ lint = [
"isort dplib --check",
"black dplib --check",
]
release = [
"""
VERSION=$(hatch run version)
git checkout main && git pull origin && git fetch -p
git log --pretty=format:"%C(yellow)%h%Creset %s%Cgreen%d" --reverse -20
echo "\nReleasing v${VERSION} in 10 seconds. Press <CTRL+C> to abort\n" && sleep 10
hatch run test && git commit -a -m 'v${VERSION}' && git tag -a v${VERSION} -m 'v${VERSION}'
git push --follow-tags
"""
]
serve = [
"mkdocs serve",
]
spec = [
"pytest --cov dplib --cov-report term-missing --cov-report html:coverage --cov-fail-under 0 --timeout=300",
]
Expand All @@ -109,8 +122,8 @@ test = [
type = [
"pyright dplib",
]
write = [
"mkdocs serve",
version = [
"hatch --no-color version"
]

[[tool.hatch.envs.ci.matrix]]
Expand Down

0 comments on commit 19940a2

Please sign in to comment.