Skip to content

Update readme #46

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.

Sign up for GitHub

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

Open
mkelley wants to merge 1 commit into
base: main
Choose a base branch
from
+16 −3
Open

Update readme #46

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 16 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,27 @@

Data analysis tools for CATCH, an astronomical survey search tool

## Testing
## Development and testing

Get required packages useful for testing:
Get required packages useful for development and testing:

```
pip install .[tests]
pip install .[dev,tests]
```

### Code formatting and linting rules

There is a pre-commit hook to enforce code format, linting, and check for a few other things (see `.pre-commmit-config.yaml`). It will automatically run when you `git commit` your code. Alternatively, the format and linting checks may be run separately on any changed files:

```
ruff format
```

```
ruff check
```


### Running the webapp (without Docker)

With the package and its dependencies installed as above, the app may be started with the command:
Expand Down
Loading