Skip to content

Commit

Permalink
updated Readme regarding local run
Browse files Browse the repository at this point in the history
  • Loading branch information
spudlig committed Dec 9, 2024
1 parent 1cf6507 commit e144edc
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 13 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,8 +154,12 @@ For detailed information about package configuration and setup, see [README_PACK
To run all checks locally:

```bash
# activate any kind of virtual environment
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate

# Install dependencies
pip install -r requirements.txt
pip install -e ".[dev,viz,docs]"

# Run formatters
black .
Expand All @@ -166,7 +170,7 @@ pylint src tests
pydocstyle src

# Run tests
pytest tests/ --cov=src
pytest tests/
```

## Contributing
Expand Down
19 changes: 8 additions & 11 deletions README_PACKAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,16 +143,6 @@ python_version = "3.11"
warn_return_any = true
```

### MANIFEST.in
```
include LICENSE
include README.md
include requirements.txt
recursive-include src/package_name/data *
recursive-include docs *.rst
global-exclude *.py[cod]
```

## Dependency Management

### Installation Options
Expand Down Expand Up @@ -282,8 +272,15 @@ Some helpful tips:
Skip hooks temporarily if needed:

```bash
Copygit commit -m "Emergency fix" --no-verify
git commit -m "Emergency fix" --no-verify
```

Skip specific hooks for a single commit using SKIP environment variable:

```bash
SKIP=black,pytest git commit -m "your message"
```
or comment out complete sections.

Update hooks to latest versions:

Expand Down

0 comments on commit e144edc

Please sign in to comment.