Skip to content

Commit

Permalink
fix
Browse files Browse the repository at this point in the history
  • Loading branch information
yokomotod committed Jan 19, 2024
1 parent 84269d7 commit 228aafa
Show file tree
Hide file tree
Showing 6 changed files with 38 additions and 20 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,20 @@ Please See [Documentation](https://gokart.readthedocs.io/en/latest/) .

Have a good gokart life.

# Contributing to gokart

install

```bash
git clone https://github.com/m3dev/gokart.git # or your own fork

poetry install --extra s3 --extra gcs --with dev-s3
```

test

```
```
# Achievements

Gokart is a proven product.
Expand Down
4 changes: 4 additions & 0 deletions docs/intro_to_gokart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ Within the activated Python environment, use the following command to install go
.. code:: sh
pip install gokart
# or
pip install gokart[s3] # to use `s3://`
# or
pip install gokart[gcs] # to use `gs://`
Expand Down
4 changes: 2 additions & 2 deletions gokart/object_storage.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,14 @@ def assert_gcs_available():
if GCS_AVAILABLE:
return

raise ImportError('gs:// is not available. Please install gokart[gcs]')
raise ImportError('gs:// is not available. You may need `pip install gokart[gcs]`')


def assert_s3_available():
if S3_AVAILABLE:
return

raise ImportError('s3:// is not available. Please install gokart[s3]')
raise ImportError('s3:// is not available. You may need `pip install gokart[s3]`')


class ObjectStorage(object):
Expand Down
22 changes: 11 additions & 11 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ google-api-python-client = {version = "*", optional = true}
APScheduler = "*"
redis = "*"
matplotlib = "*"
pytest = "*"

[tool.poetry.group.dev.dependencies]
pyproject-flake8 = "5.0.4"
Expand All @@ -43,10 +42,11 @@ lupa = "*"
fakeredis = "*"
mypy = "*"
types-redis = "*"
pytest = "*"

# for dev, extra is installed by default
[tool.poetry.group.dev-extra.dependencies]
google-api-python-client = "*"
[tool.poetry.group.dev-s3]
optional = true
[tool.poetry.group.dev-s3.dependencies]
moto = "*"

[tool.poetry.extras]
Expand Down
6 changes: 3 additions & 3 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ isolated_build = true
allowlist_externals = poetry, pytest
skip_install = true
commands =
s3: poetry install -E s3 --without=dev-extra
s3: poetry install --extra s3 --with=dev-s3
s3: pytest -v -m "s3"

gcs: poetry install -E gcs --without=dev-extra
gcs: poetry install --extra gcs
gcs: pytest -v -m "gcs"

core: poetry install --without=dev-extra
core: poetry install
core: pytest -v -m "not gcs and not s3"

[testenv:yapf]
Expand Down

0 comments on commit 228aafa

Please sign in to comment.