Skip to content

Commit 0c90aa3

Browse files
authored
Merge pull request #51 from scaleapi/da/pip_install
Switch to poetry to make publishing easy
2 parents 98f318c + 183f330 commit 0c90aa3

File tree

4 files changed

+35
-69
lines changed

4 files changed

+35
-69
lines changed

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,7 @@ Nucleus is a new way—the right way—to develop ML models, helping us move awa
1717

1818
## Installation
1919

20-
### Editable mode
21-
22-
`$ pip install -e . `
23-
24-
### As a Normal Package
25-
26-
`$ pip install git+ssh://git@github.com/scaleapi/nucleus-python-client.git`
20+
`$ pip install scale-nucleus`
2721

2822
## Usage
2923

@@ -159,6 +153,15 @@ client.delete_model_run("model_run_id")
159153

160154
## For Developers
161155

156+
Clone from github and install as editable
157+
158+
```
159+
git clone git@github.com:scaleapi/nucleus-python-client.git
160+
cd nucleus-python-client
161+
pip3 install poetry
162+
poetry install
163+
```
164+
162165
Please install the pre-commit hooks by running the following commands:
163166
```python
164167
pip install pre-commit

pyproject.toml

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ line-length = 79
33
target-version = ['py37']
44
include = '\.pyi?$'
55
exclude = '''
6-
76
(
87
/(
98
\.eggs # exclude a few common directories in the
@@ -17,11 +16,32 @@ exclude = '''
1716
| build
1817
| dist
1918
)/
20-
| foo.py # also separately exclude a file named foo.py in
21-
# the root of the project
2219
)
2320
'''
2421

22+
[tool.poetry]
23+
name = "scale-nucleus"
24+
version = "0.1.0"
25+
description = "The official Python client library for Nucleus, the Data Platform for AI"
26+
license = "MIT"
27+
authors = ["Scale AI Nucleus Team <nucleusapi@scaleapi.com>"]
28+
readme = "README.md"
29+
homepage = "https://scale.com/nucleus"
30+
repository = "https://github.com/scaleapi/nucleus-python-client"
31+
documentation = "https://dashboard.scale.com/nucleus/docs/api"
32+
packages = [{include="nucleus"}]
33+
34+
[tool.poetry.dependencies]
35+
python = "^3.6"
36+
grequests = "^0.6.0"
37+
requests = "^2.25.1"
38+
tqdm = "^4.60.0"
39+
40+
[tool.poetry.dev-dependencies]
41+
poetry = "^1.1.5"
42+
pytest = "^6.2.3"
43+
pylint = "^2.7.4"
44+
2545
[build-system]
26-
requires = ["setuptools", "wheel"]
27-
build-backend = "setuptools.build_meta:__legacy__"
46+
requires = ["poetry-core>=1.0.0"]
47+
build-backend = "poetry.core.masonry.api"

requirements.txt

Lines changed: 0 additions & 5 deletions
This file was deleted.

setup.py

Lines changed: 0 additions & 52 deletions
This file was deleted.

0 commit comments

Comments
 (0)