MAINT - Maintenance improvements to repo (#56)

.eslintignore

@@ -6,3 +6,7 @@ tests
 
 **/__tests__
 ui-tests
+
+# Ignore files for NPM and YARN
+package-lock.json
+yarn.lock

.github/workflows/build.yml → .github/workflows/CI.yml

@@ -1,4 +1,4 @@
-name: 'Build extension'
+name: 'Continuous Integration'
 
 on:
  push:

.prettierignore

@@ -3,3 +3,7 @@ node_modules
 **/lib
 **/package.json
 jupyterlab_conda_store
+
+# Ignore files for NPM and YARN
+package-lock.json
+yarn.lock

README.md

@@ -64,46 +64,51 @@ pip uninstall jupyterlab-conda-store
  cd jupyterlab-conda-store
  ```
 
-3. Optional but recommended - Create and activate a development environment with conda:
+3. Create a new conda environment:
 
  ```bash
- # Create environment named `jupyterlab-conda-store`
- conda create -n jupyterlab-conda-store
+ conda env create -f environment.yml
+
+ # activate the environment
  conda activate jupyterlab-conda-store
  ```
 
-4. Install JupyterLab and NodeJS **if not installed**:
+4. Install the package in development mode:
 
  ```bash
- # Install node and jupyterlab from conda-forge
- conda install -c conda-forge 'nodejs>16' 'jupyterlab>=4'
+ python -m pip install -e .
  ```
 
-5. Install the package in development mode:
+5. Now you'll need to link the development version of the extension to JupyterLab and rebuild the Typescript source:
 
  ```bash
- pip install -e .
+ # Install the extension dependencies
+ jlpm install
+ # Link your development version of the extension with JupyterLab
+ jupyter labextension develop . --overwrite
  ```
 
-6. Now you'll need to link the development version of the extension to JupyterLab and rebuild the Typescript source:
+6. On the first installation, or after making some changes, to visualize them in your local JupyterLab re-run the following command:
 
  ```bash
- # Link your development version of the extension with JupyterLab
- jupyter labextension develop . --overwrite
+ # Rebuild extension Typescript source after making changes
+ jlpm run build
  ```
 
-7. On the first installation, or after making some changes, to visualize them in your local JupyterLab re-run the following command:
+7. Run JupyterLab and check that the installation worked:
 
  ```bash
- # Rebuild extension Typescript source after making changes
- jlpm build
+ # Run JupyterLab
+ jupyter lab
  ```
 
-8. Run JupyterLab and check that the installation worked:
+> [!TIP]
+> At times you might need to clean your local repo with the command `npm run clean:slate`. This will clean the repository, and re-install and rebuild.
+
+To lint files as you work on contributions, you can run:
 
 ```bash
-# Run JupyterLab
-jupyter lab
+jlpm run lint:check
 ```
 
 ### Uninstalling the development version

RELEASE.md

@@ -18,7 +18,7 @@ All the Python packaging instructions in the `pyproject.toml` file to wrap your
 > [!IMPORTANT]
 > There is no need to update the version in `pyproject.toml` as it is automatically updated by `hatch` when generating the package.
 
-3. Optional - if there is a newer release of `conda-store-ui`, update the `conda-store-ui` dependency in the package.json file.
+3. Optional - if there is a newer release of `conda-store-ui`, update the `conda-store-ui` dependency in the `package.json` file.
 
  ```bash
  yarn upgrade @conda-store/conda-store-ui@<version>
@@ -27,7 +27,7 @@ All the Python packaging instructions in the `pyproject.toml` file to wrap your
 4. To create a Python source package (`.tar.gz`) and the binary package (`.whl`) in the `dist/` directory, do:
 
  ```bash
- python -m build
+ hatch build
  ```
 
 `python setup.py sdist bdist_wheel` is deprecated and will not work for this package.

environment.yaml

@@ -0,0 +1,8 @@
+name: jupyterlab-conda-store
+channels:
+ - conda-forge
+ - nodefaults
+dependencies:
+ - python>=3.9
+ - nodejs=20
+ - jupyterlab>=4

pyproject.toml

@@ -7,7 +7,7 @@ name = "jupyterlab-conda-store"
 description = "A JupyterLab extension that provides a user-friendly graphical interface for building and managing environments using an existing conda-store server"
 readme = "README.md"
 license = { file = "LICENSE" }
-requires-python = ">=3.8"
+requires-python = ">=3.9"
 maintainers = [{ name = "Tania Allard", email = "[email protected]" }]
 keywords = ["Jupyter", "JupyterLab", "JupyterLab4", "conda", "environments"]
 classifiers = [
@@ -37,6 +37,7 @@ test = [
  "pytest-cov",
  "pytest-tornasync"
 ]
+dev = ["hatch"]
 
 [project.urls]
 Homepage = "https:/conda-incubator/jupyterlab-conda-store"