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

fix: installation instructions #127

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all 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/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
fail-fast: false
matrix:
os: [ubuntu-latest, windows-latest, macos-latest]
python-version: ["3.7", "3.10"]
python-version: ["3.8", "3.11"]
steps:
- name: Checkout
uses: actions/checkout@v2
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ Install the python. This will also build the TS package.

```bash
# First install the python package. This will also build the JS packages.
yarn install
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a better way to do this?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we just need to use jlpm to install the dependencies: #128?

pip install -e ".[test, examples]"

# Run the python tests. This should not give you a few sucessful example tests
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
fail-fast: false
matrix:
os: [ubuntu-latest, windows-latest, macos-latest]
python-version: ["3.7", "3.10"]
python-version: ["3.8", "3.11"]
steps:
- name: Checkout
uses: actions/checkout@v2
Expand All @@ -26,6 +26,7 @@ jobs:
npm install -g codecov
- name: Test the extension
run: |
yarn install
python -m pip install --upgrade -v -e ".[test, examples, docs]"
python -m pytest
yarn run test
Expand Down
1 change: 1 addition & 0 deletions {{cookiecutter.github_project_name}}/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ conda activate {{ cookiecutter.python_package_name }}-dev

Install the python. This will also build the TS package.
```bash
yarn install
pip install -e ".[test, examples]"
```

Expand Down
8 changes: 4 additions & 4 deletions {{cookiecutter.github_project_name}}/pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[build-system]
requires = [
"hatchling>=1.3.1",
"hatchling>=1.6.0",
"jupyterlab==3.*",
]
build-backend = "hatchling.build"
Expand All @@ -10,7 +10,7 @@ name = "{{ cookiecutter.python_package_name }}"
description = "{{ cookiecutter.project_short_description }}"
readme = "README.md"
license = { file = "LICENSE.txt" }
requires-python = ">=3.7"
requires-python = ">=3.8"
authors = [
{ name = "{{ cookiecutter.author_name }}", email = "{{ cookiecutter.author_email }}" },
]
Expand All @@ -26,10 +26,10 @@ classifiers = [
"License :: OSI Approved :: BSD License",
"Programming Language :: Python",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
]
dependencies = [
"ipywidgets>=7.0.0",
Expand Down Expand Up @@ -86,7 +86,7 @@ skip-if-exists = [
"{{ cookiecutter.python_package_name }}/labextension/package.json",
]
dependencies = [
"hatch-jupyter-builder>=0.5.0",
"hatch-jupyter-builder>=0.8.2",
]

[tool.hatch.build.hooks.jupyter-builder.build-kwargs]
Expand Down