Skip to main content

Conveniences for running Datasette on GitHub Codespaces

Project description

datasette-codespaces

PyPI Changelog Tests License

Conveniences for running Datasette on GitHub Codespaces

Installation

Install this plugin in the same environment as Datasette.

datasette install datasette-codespaces

Tutorial

Using Datasette in GitHub Codespaces provides a detailed tutorial introduction to this plugin.

Usage

Install this when you are using Datasette inside of GitHub Codespaces. It makes the following changes:

  • All requests will be treated as the root actor provided Datasette is running inside Codespaces (detected through the presence of the CODESPACE_NAME environment variable). This should still be secure as GitHub restricts access to servers running in the Codespaces environment based on GitHub authentication.
  • The datasette-x-forwarded-host plugin will be installed, ensuring links to other pages within Datasette such as facet navigation work correctly.

Development

To set up this plugin locally, first checkout the code. Then create a new virtual environment:

cd datasette-codespaces
python3 -m venv venv
source venv/bin/activate

Now install the dependencies and test dependencies:

pip install -e '.[test]'

To run the tests:

pytest

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

datasette-codespaces-0.1.1.tar.gz (6.8 kB view hashes)

Uploaded Source

Built Distribution

datasette_codespaces-0.1.1-py3-none-any.whl (7.0 kB view hashes)

Uploaded Python 3

Supported by

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