Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/osamaahmed17/gsoc2023_task1
This extension displays the weather for a city given by the user. It allows the user to search for a city through querying the weather API
https://github.com/osamaahmed17/gsoc2023_task1
Last synced: 18 days ago
JSON representation
This extension displays the weather for a city given by the user. It allows the user to search for a city through querying the weather API
- Host: GitHub
- URL: https://github.com/osamaahmed17/gsoc2023_task1
- Owner: osamaahmed17
- License: bsd-3-clause
- Created: 2023-03-12T12:04:37.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-19T00:33:37.000Z (almost 2 years ago)
- Last Synced: 2024-12-13T08:32:56.807Z (27 days ago)
- Language: TypeScript
- Size: 362 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Google Summer of Code 2023 - Query Weather
[](https://github.com/osamaahmed17/gsoc2023_task1/actions/workflows/build.yml)[](https://mybinder.org/v2/gh/osamaahmed17/gsoc2023_task1/main?urlpath=lab)
This extension displays the weather for a city given by the user. It allows the user to search for a city through querying the weather API
## Requirements
- JupyterLab >= 3.0
## Install
To install the extension, execute:
```bash
pip install gsoc2023_task1
```
## Uninstall
To remove the extension, execute:
```bash
pip uninstall gsoc2023_task1
```
## Contributing
### Development install
Note: You will need NodeJS to build the extension package.
The `jlpm` command is JupyterLab's pinned version of
[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
`yarn` or `npm` in lieu of `jlpm` below.
```bash
# Clone the repo to your local environment
# Change directory to the gsoc2023_task1 directory
# Install package in development mode
pip install -e "."
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm build
```
You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
```bash
# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm watch
# Run JupyterLab in another terminal
jupyter lab
```
With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).
By default, the `jlpm build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:
```bash
jupyter lab build --minimize=False
```
### Development uninstall
```bash
pip uninstall gsoc2023_task1
```
In development mode, you will also need to remove the symlink created by `jupyter labextension develop`
command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`
folder is located. Then you can remove the symlink named `gsoc2023_task1` within that folder.
### Testing the extension
#### Frontend tests
This extension is using [Jest](https://jestjs.io/) for JavaScript code testing.
To execute them, execute:
```sh
jlpm
jlpm test
```
#### Integration tests
This extension uses [Playwright](https://playwright.dev/docs/intro/) for the integration tests (aka user level tests).
More precisely, the JupyterLab helper [Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to handle testing the extension in JupyterLab.
More information are provided within the [ui-tests](./ui-tests/README.md) README.
### Packaging the extension
See [RELEASE](RELEASE.md)