diff --git a/README.md b/README.md index 7c3a409..e861138 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,8 @@ - Python 3.12 or higher +### Installation from Source + Clone the repository: ```bash @@ -42,13 +44,15 @@ cd doi2dataset ### Quick Start ```bash -# Install the package +# Install the package in development mode pip install -e . # Run with a DOI doi2dataset 10.1038/nature12373 ``` +**Note:** The package is not yet available on PyPI. Please use the Git installation method above. + ## 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: diff --git a/docs/source/installation.rst b/docs/source/installation.rst index 316537e..3546fad 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -15,14 +15,21 @@ Clone the repository by running the following commands in your terminal: # Install in development mode pip install -e . -Using pip (if available) -------------------------- -You can also install **doi2dataset** via pip: +Using pip (when available) +-------------------------- +Once published to PyPI, you will be able to install **doi2dataset** via pip: .. code-block:: bash 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 ------------------------ Install in editable mode for development: @@ -34,7 +41,7 @@ Install in editable mode for development: pip install -e . # Install development dependencies - pip install -r requirements-dev.txt + pip install -e ".[dev]" # Set up pre-commit hooks pre-commit install --hook-type pre-commit --hook-type commit-msg