Skip to content

Commit

Permalink
Add dev optional dependency (#835)
Browse files Browse the repository at this point in the history
  • Loading branch information
zacharyburnett authored Aug 21, 2023
2 parents bfd0070 + 1403516 commit a206752
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,8 @@ general

- Remove use of the deprecated ``pkg_resources`` module from ``setuptools``. [#829]

- Add ``dev`` install option. [#835]

0.11.0 (2023-05-31)
===================

Expand Down
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,14 @@ installed too:
pip install -e ".[docs]"
pip install -e ".[test,docs]"


Note that if you wish to install all the development dependencies (`test` and `docs`) as well as the development
tools used for linting and reproducible environments run:

pip install -e ".[dev]"

This will install `tox` and the `pre-commit` tools in addition to all development dependencies.

Need other useful packages in your development environment?

pip install ipython pytest-xdist
Expand Down
5 changes: 5 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,11 @@ test = [
'pytest-astropy',
'metrics_logger >= 0.1.0',
]
dev = [
'romancal[docs,test]',
'tox > 4',
'pre-commit > 3'
]

[project.urls]
'tracker' = 'https://github.com/spacetelescope/romancal/issues'
Expand Down

0 comments on commit a206752

Please sign in to comment.