Pyzotero: a Python client for the Zotero API
pyzotero.readthedocs.io
zotero
Merge pull request #244 from urschrei/shugel/push-ylpxltsxqyqq
README install instructions update
authored by
GitHub
c6cb5ccd
6111ad1c
+8
-6
+8
-6
README.md
+8
-6
README.md
···
30
30
31
31
# Installation
32
32
33
-
* Using [pip][10]: `pip install pyzotero` (it's available as a wheel, and is tested on Python 3.7 and up)
34
-
* Using Anaconda:`conda config --add channels conda-forge && conda install pyzotero`
33
+
* Using [uv][11]: `uv add pyzotero`
34
+
* Using [pip][10]: `pip install pyzotero`
35
+
* Using Anaconda:`conda install conda-forge::pyzotero`
35
36
* From a local clone, if you wish to install Pyzotero from a specific branch:
36
37
37
38
Example:
···
40
41
git clone git://github.com/urschrei/pyzotero.git
41
42
cd pyzotero
42
43
git checkout main
43
-
pip install .
44
+
# specify --dev if you're planning on running tests
45
+
uv sync
44
46
```
45
47
46
48
## Testing
47
49
48
-
Run `pytest .` from the top-level directory.
50
+
Run `pytest .` from the top-level directory. This requires the `dev` dependency group to be installed: `uv sync --dev` / `pip install --group dev`
49
51
50
52
## Issues
51
53
···
53
55
54
56
## Pull Requests
55
57
56
-
Pull requests are welcomed. Please read the [contribution guidelines](CONTRIBUTING.md). In particular, please **base your PR on the `dev` branch**.
58
+
Pull requests are welcomed. Please read the [contribution guidelines](CONTRIBUTING.md). In particular, please **base your PR on the `main` branch**.
57
59
58
60
## Versioning
59
61
60
62
As of v1.0.0, Pyzotero is versioned according to [Semver](http://semver.org); version increments are performed as follows:
61
-
62
63
63
64
64
65
1. MAJOR version will increment with incompatible API changes,
···
84
85
[8]: https://opensource.org/license/blue-oak-model-license
85
86
[9]: https://github.com/urschrei/pyzotero/tree/main
86
87
[10]: http://www.pip-installer.org/en/latest/index.html
88
+
[11]: https://docs.astral.sh/uv
87
89
† This isn't strictly true: you only need an API key for personal libraries and non-public group libraries.
88
90