Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make hatch a prerequisite #137

Merged
merged 4 commits into from
Aug 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .github/workflows/push.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ on:
branches:
- main

env:
HATCH_VERSION: 1.9.4

jobs:
ci:
strategy:
Expand All @@ -32,6 +35,9 @@ jobs:
cache-dependency-path: '**/pyproject.toml'
python-version: ${{ matrix.pyVersion }}

- name: Install hatch
run: pip install hatch==$HATCH_VERSION

- name: Run unit tests
run: |
pip install hatch==1.9.4
Expand All @@ -48,6 +54,9 @@ jobs:
- name: Checkout
uses: actions/checkout@v4.1.7

- name: Install hatch
run: pip install hatch==$HATCH_VERSION

- name: Format all files
run: make dev fmt

Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,8 @@ def viz_type(self) -> str:
## Local Setup

This section provides a step-by-step guide to set up and start working on the project. These steps will help you set up your project environment and dependencies for efficient development.

To begin, run `make dev` create the default environment and install development dependencies, assuming you've already cloned the github repo.
Please note that hatch is a prerequisite. You can install hatch using `pip install hatch`.
To begin, run `make dev` to create the default environment and install development dependencies, assuming you've already cloned the github repo.

```shell
make dev
Expand Down
1 change: 0 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ clean:
rm -fr **/*.pyc

.venv/bin/python:
pip install hatch
hatch env create

dev: .venv/bin/python
Expand Down