https://github.com/nezhar/jupyter-docker-compose
Easy Jupyter development with Docker and Docker Compose
https://github.com/nezhar/jupyter-docker-compose
docker hacktoberfest jupyter workflow
Last synced: about 1 year ago
JSON representation
Easy Jupyter development with Docker and Docker Compose
- Host: GitHub
- URL: https://github.com/nezhar/jupyter-docker-compose
- Owner: nezhar
- License: mit
- Created: 2023-04-19T19:12:14.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T19:16:41.000Z (over 1 year ago)
- Last Synced: 2025-04-02T12:12:58.232Z (about 1 year ago)
- Topics: docker, hacktoberfest, jupyter, workflow
- Language: Dockerfile
- Homepage: https://nezhar.com/blog/jupyter-notebook-development-workspace-using-docker-and-git/
- Size: 7.81 KB
- Stars: 48
- Watchers: 3
- Forks: 35
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Jupyter Docker Compose
A quick and easy setup for running Jupyter notebooks in a Dockerized environment, managed using [Docker Compose](https://docs.docker.com/compose/). This setup makes it simple to get up and running with Jupyter, share notebooks across multiple team members, and maintain consistent environments. It is also compatible with GitHub Code Spaces for remote development.
## Features
- GitHub Template repository for easy reuse.
- Dockerized Jupyter environment for consistent, reproducible notebook runs.
- Simplified sharing of notebooks using the `work` directory.
- Compatibility with GitHub Code Spaces for seamless remote development.
## Getting Started
Clone this repository to your local machine:
```bash
git clone https://github.com/nezhar/jupyter-docker-compose.git
```
Navigate to the project root directory:
```bash
cd jupyter-docker-compose
```
Build the the image for the Jupyter Notebook server:
```bash
docker compose build
```
Start the Jupyter Notebook server:
```bash
docker compose up
```
After running this command, the Jupyter Notebook server should be accessible at `http://localhost:8888`.
## Using GitHub Code Spaces
This setup can also be used with GitHub Code Spaces. All the necessary configuration is provided in the `devcontainer.json` file. Just open this repository in a new code space, and the environment will be ready to go.
## Directory Structure
- `./work`: This is the directory where you can add your Jupyter notebooks. It's mounted as a volume in the Docker container, so notebooks created and saved in the Jupyter Notebook IDE will persist here.
## Notes
The `requirements.txt` file is copied to the Docker container during the build process, and the Python dependencies listed within are installed. To add or update dependencies, modify this file, then rebuild the Docker image.
## Contributions
Contributions to this project are welcome! Please create an issue or submit a pull request.
## License
This project is licensed under the MIT License - see the LICENSE file for details.