Skip to main content

ESASky Python wrapper

Project description

pyesasky

Github Actions Status Binder

ESASky Python wrapper

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install pyesasky

Uninstall

To remove the extension, execute:

pip uninstall pyesasky

Contributing

Development install

Note: You will need NodeJS to build the extension package.

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# Clone the repo to your local environment
# Change directory to the pyesasky 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.

# 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:

jupyter lab build --minimize=False

Development uninstall

pip uninstall pyesasky

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 pyesasky within that folder.

Testing the extension

Frontend tests

This extension is using Jest for JavaScript code testing.

To execute them, execute:

jlpm
jlpm test

Integration tests

This extension uses Playwright for the integration tests (aka user level tests). More precisely, the JupyterLab helper Galata is used to handle testing the extension in JupyterLab.

More information are provided within the ui-tests README.

Packaging the extension

See RELEASE

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyesasky-2.0.4.tar.gz (1.6 MB view details)

Uploaded Source

Built Distribution

pyesasky-2.0.4-py3-none-any.whl (36.4 kB view details)

Uploaded Python 3

File details

Details for the file pyesasky-2.0.4.tar.gz.

File metadata

  • Download URL: pyesasky-2.0.4.tar.gz
  • Upload date:
  • Size: 1.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for pyesasky-2.0.4.tar.gz
Algorithm Hash digest
SHA256 42cafe85ed391a90afebeb33b87ea24455a93617538db3d5b80ea7395889d3a2
MD5 3287c33fc6864fb119265faee8a93368
BLAKE2b-256 af0dbbd3eb979f966937ab4af116b449331de782e64b89e3c38c34f60e780e88

See more details on using hashes here.

File details

Details for the file pyesasky-2.0.4-py3-none-any.whl.

File metadata

  • Download URL: pyesasky-2.0.4-py3-none-any.whl
  • Upload date:
  • Size: 36.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for pyesasky-2.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 de520b2e6c6f9e18d77ea45278f8712fb4632625bdbf63997b2daa6bdc98b582
MD5 c4e764045ef7144ac1e09198854554a8
BLAKE2b-256 ce14cf438c436a44c3d1c0ea041136bcdcfce9f5f5cef582e1c9a962d264b306

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page