Athemis/doi2dataset
1
0
Fork 0
Code Issues Pull requests Projects Releases 3 Packages Wiki Activity Actions

docs: update installation and README

Browse source 
- clarify that pip installation is not yet available on PyPI
- update installation instructions to use development installation
- add note about Python 3.12+ requirement
- improve development setup instructions
This commit is contained in:
Alexander Minges 2025-07-25 09:46:58 +02:00
parent de27e8168f
commit babbf99203
Signed by: Athemis
SSH key fingerprint: SHA256:TUXshgulbwL+FRYvBNo54pCsI0auROsSEgSvueKbkZ4
2 changed files with 16 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -32,6 +32,8 @@
- Python 3.12 or higher - Python 3.12 or higher
### Installation from Source
Clone the repository: Clone the repository:
```bash ```bash
@ -42,13 +44,15 @@ cd doi2dataset
### Quick Start ### Quick Start
```bash ```bash
# Install the package # Install the package in development mode
pip install -e . pip install -e .
# Run with a DOI # Run with a DOI
doi2dataset 10.1038/nature12373 doi2dataset 10.1038/nature12373
``` ```
**Note:** The package is not yet available on PyPI. Please use the Git installation method above.
## Configuration ## Configuration
Before running the tool, configure the necessary settings in the `config.yaml` file located in the project root. This file contains configuration details such as: Before running the tool, configure the necessary settings in the `config.yaml` file located in the project root. This file contains configuration details such as:

15
docs/source/installation.rst
View file

@ -15,14 +15,21 @@ Clone the repository by running the following commands in your terminal:
# Install in development mode # Install in development mode
pip install -e . pip install -e .
Using pip (if available) Using pip (when available)
------------------------- --------------------------
You can also install **doi2dataset** via pip: Once published to PyPI, you will be able to install **doi2dataset** via pip:
.. code-block:: bash .. code-block:: bash
pip install doi2dataset pip install doi2dataset
.. note::
Currently, the package is not yet available on PyPI. Please use the Git installation method below.
Requirements
------------
**doi2dataset** requires Python 3.12 or higher.
Development Installation Development Installation
------------------------ ------------------------
Install in editable mode for development: Install in editable mode for development:
@ -34,7 +41,7 @@ Install in editable mode for development:
pip install -e . pip install -e .
# Install development dependencies # Install development dependencies
pip install -r requirements-dev.txt pip install -e ".[dev]"
# Set up pre-commit hooks # Set up pre-commit hooks
pre-commit install --hook-type pre-commit --hook-type commit-msg pre-commit install --hook-type pre-commit --hook-type commit-msg