moved to uv pyproject. new instructions for installation in README.md
This commit is contained in:
parent
5f356e3292
commit
0684c0ee47
20
README.md
20
README.md
|
|
@ -42,20 +42,24 @@ A Python library that provides authentication, configuration, and client functio
|
|||
cd d4science-python-library
|
||||
```
|
||||
|
||||
2. Install the dependencies:
|
||||
2. Install the library. Choose one of the following methods:
|
||||
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
3. Install the library in editable mode to make the CLI available:
|
||||
|
||||
**Option A: Using virtual environment (recommended for development):**
|
||||
**A) Editable Install (for development)**
|
||||
|
||||
This method links the installed package back to your source code. Any changes you make to the code will be immediately available without reinstalling. This is the recommended method for developers.
|
||||
|
||||
```bash
|
||||
pip install -e .
|
||||
```
|
||||
|
||||
**B) Standalone Install**
|
||||
|
||||
This method builds and installs the package in your Python environment, just like installing a package from PyPI. This is suitable for users who want to use the library without modifying its source code.
|
||||
|
||||
```bash
|
||||
pip install .
|
||||
```
|
||||
|
||||
**Option B: Global installation (for system-wide CLI access):**
|
||||
|
||||
On macOS with Homebrew-managed Python:
|
||||
|
|
|
|||
|
|
@ -11,9 +11,12 @@ dependencies = [
|
|||
"requests>=2.25.0",
|
||||
"requests-oauthlib>=2.0.0",
|
||||
"pydantic>=2.4.0",
|
||||
"typer[all]"
|
||||
"typer"
|
||||
]
|
||||
|
||||
[project.scripts]
|
||||
d4science = "d4science.main:cli"
|
||||
|
||||
[project.optional-dependencies]
|
||||
dev = [
|
||||
"pytest",
|
||||
|
|
|
|||
|
|
@ -1,5 +0,0 @@
|
|||
requests>=2.25.0
|
||||
requests-oauthlib>=2.0.0
|
||||
pydantic>=2.4.0
|
||||
typer[all]
|
||||
|
||||
23
setup.py
23
setup.py
|
|
@ -1,23 +0,0 @@
|
|||
from setuptools import setup, find_packages
|
||||
|
||||
setup(
|
||||
name="d4science",
|
||||
version="0.2.1",
|
||||
packages=find_packages(),
|
||||
install_requires=[
|
||||
"requests>=2.25.0",
|
||||
"requests-oauthlib>=2.0.0",
|
||||
"pydantic>=2.4.0",
|
||||
"typer[all]>=0.9.0",
|
||||
],
|
||||
entry_points={
|
||||
'console_scripts': [
|
||||
'd4science=d4science.main:cli',
|
||||
],
|
||||
},
|
||||
author="Alfredo Oliviero",
|
||||
author_email="alfredo.oliviero@isti.cnr.it",
|
||||
description="Python client library and CLI for D4Science services",
|
||||
keywords="d4science, api, client, storagehub, auth, cli, typer",
|
||||
python_requires=">=3.8",
|
||||
)
|
||||
Loading…
Reference in New Issue