Skip to content

Commit 50fe154

Browse files
committed
Add ORCIDs and revise build and test instructions.
1 parent 63ca980 commit 50fe154

1 file changed

Lines changed: 10 additions & 7 deletions

File tree

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# DataONE Auth Library for python services
22

3-
- **Authors**: Rushiraj Nenuji, (ORCID); Matthew B. Jones (ORCID); and Jeanette Clark (ORCID)
3+
- **Authors**: Rushiraj Nenuji, [0000-0003-4678-5213](https://orcid.org/0000-0003-4678-5213); Matthew B. Jones [0000-0003-0077-4738](https://orcid.org/0000-0003-0077-4738); and Jeanette Clark [0000-0003-4703-1974](https://orcid.org/0000-0003-4703-1974)
44
- **License**: [Apache 2](http://opensource.org/licenses/Apache-2.0)
55
- [Package source code on GitHub](https://github.com/DataONEorg/dataone-auth)
66
- [**Submit Bugs and feature requests**](https://github.com/DataONEorg/dataone-auth/issues)
@@ -20,19 +20,22 @@ Documentation is a work in progress, and can be found ...
2020
This is a python package, and built using the [uv](https://uv-astral.sh) build tool, among others.
2121

2222
To install locally, create a virtual environment for python.
23-
Install `uv`, and then sync the package dependencies with `uv sync`.
23+
Install `uv`, and then sync the package dependencies:
2424

25-
To install the package:
26-
```
27-
pip install dataone-auth
28-
```
25+
- `uv sync`.
2926

3027
Then import it in your code:
3128
```python
3229
import dataone.auth
3330
```
3431

35-
To run tests, navigate to the root directory and run `pytest -s`.
32+
To run tests, navigate to the root directory and run pytest:
33+
34+
- `uv run pytest`
35+
36+
To run the code formatter and linter, use Ruff:
37+
38+
- `uv run ruff check .`
3639

3740
## Usage Example
3841

0 commit comments

Comments
 (0)