Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Don't require fire as base dependency and add lightning_tools[dev] installation #42

Merged
merged 5 commits into from
Sep 7, 2022
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci-testing.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ jobs:
- name: Set oldest dependencies
if: matrix.requires == 'oldest'
run: |
pip install -e .
pip install -e '.[dev]'
python -m lightning_utilities.dev requirements set-oldest

- uses: ./.github/actions/cache
Expand Down
28 changes: 26 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ jobs:
# requires: latest
```

## 3. CLI
## 3. CLI `lightning_utilities.dev`

The package provides common CLI commands.

Expand All @@ -71,7 +71,7 @@ pip install https://github.com/Lightning-AI/utilities/archive/refs/heads/main.zi
From pypi:

```bash
pip install lightning_utilities
pip install lightning_utilities[dev]
```

</details>
Expand Down Expand Up @@ -102,3 +102,27 @@ pytest-timeout
```

</details>

## 4. General Python utilities `lightning_utilities.core`

<details>
<summary>Installation</summary>

From pypi:

```bash
pip install lightning_utilities
```

</details>

__Usage:__

Example for optional imports:

```python
from lightning_utilities.core.imports import module_available

if module_available("some_package.something"):
from some_package import something
```
1 change: 0 additions & 1 deletion requirements/base.txt
Original file line number Diff line number Diff line change
@@ -1 +0,0 @@
fire
carmocca marked this conversation as resolved.
Show resolved Hide resolved
1 change: 1 addition & 0 deletions requirements/dev.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
fire
5 changes: 5 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ def _load_py_module(fname, pkg="lightning_utilities"):
about = _load_py_module("__about__.py")
with open(os.path.join(_PATH_REQUIRE, "base.txt")) as fp:
requirements = list(map(str, parse_requirements(fp.readline())))
with open(os.path.join(_PATH_REQUIRE, "dev.txt")) as fp:
requirements_dev = list(map(str, parse_requirements(fp.readline())))
with open(os.path.join(_PATH_ROOT, "README.md")) as fp:
readme = fp.read()

Expand All @@ -43,6 +45,9 @@ def _load_py_module(fname, pkg="lightning_utilities"):
python_requires=">=3.7",
setup_requires=[],
install_requires=requirements,
extras_require={
"dev": requirements_dev,
},
project_urls={
"Bug Tracker": "https://github.com/Lightning-AI/utilities/issues",
"Documentation": "https://dev-toolbox.rtfd.io/en/latest/", # TODO: Update domain
Expand Down