-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'origin/main' into hayes-dev
- Loading branch information
Showing
17 changed files
with
5,434 additions
and
5,950 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,89 +1,3 @@ | ||
See the [Scientific Python Developer Guide][spc-dev-intro] for a detailed | ||
description of best practices for developing scientific packages. | ||
Contributions are welcome, please see our documentation: | ||
|
||
[spc-dev-intro]: https://learn.scientific-python.org/development/ | ||
|
||
# Quick development | ||
|
||
The fastest way to start with development is to use nox. If you don't have nox, | ||
you can use `pipx run nox` to run it without installing, or `pipx install nox`. | ||
If you don't have pipx (pip for applications), then you can install with | ||
`pip install pipx` (the only case were installing an application with regular | ||
pip is reasonable). If you use macOS, then pipx and nox are both in brew, use | ||
`brew install pipx nox`. | ||
|
||
To use, run `nox`. This will lint and test using every installed version of | ||
Python on your system, skipping ones that are not installed. You can also run | ||
specific jobs: | ||
|
||
```console | ||
$ nox -s lint # Lint only | ||
$ nox -s tests # Python tests | ||
$ nox -s docs -- --serve # Build and serve the docs | ||
$ nox -s build # Make an SDist and wheel | ||
``` | ||
|
||
Nox handles everything for you, including setting up an temporary virtual | ||
environment for each run. | ||
|
||
# Setting up a development environment manually | ||
|
||
You can set up a development environment by running: | ||
|
||
```bash | ||
python3 -m venv .venv | ||
source ./.venv/bin/activate | ||
pip install -v -e .[dev] | ||
``` | ||
|
||
If you have the | ||
[Python Launcher for Unix](https://github.com/brettcannon/python-launcher), you | ||
can instead do: | ||
|
||
```bash | ||
py -m venv .venv | ||
py -m install -v -e .[dev] | ||
``` | ||
|
||
# Pre-commit | ||
|
||
You should prepare pre-commit, which will help you by checking that commits pass | ||
required checks: | ||
|
||
```bash | ||
pip install pre-commit # or brew install pre-commit on macOS | ||
pre-commit install # Will install a pre-commit hook into the git repo | ||
``` | ||
|
||
You can also/alternatively run `pre-commit run` (changes only) or | ||
`pre-commit run --all-files` to check even without installing the hook. | ||
|
||
# Testing | ||
|
||
Use pytest to run the unit checks: | ||
|
||
```bash | ||
pytest | ||
``` | ||
|
||
# Coverage | ||
|
||
Use pytest-cov to generate coverage reports: | ||
|
||
```bash | ||
pytest --cov=coincident | ||
``` | ||
|
||
# Building docs | ||
|
||
You can build the docs using: | ||
|
||
```bash | ||
nox -s docs | ||
``` | ||
|
||
You can see a preview with: | ||
|
||
```bash | ||
nox -s docs -- --serve | ||
``` | ||
https://coincident.readthedocs.io/en/latest/user_guide/contribute.html |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,7 +2,7 @@ name: CI | |
|
||
on: | ||
schedule: | ||
- cron: 0 0 * * * | ||
- cron: 0 0 * * * | ||
workflow_dispatch: | ||
pull_request: | ||
push: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -15,7 +15,6 @@ jobs: | |
|
||
- uses: prefix-dev/[email protected] | ||
with: | ||
pixi-version: v0.34.0 | ||
environments: dev | ||
manifest-path: pyproject.toml | ||
cache: false | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.