Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/miolab/jupyterlab_poetry
JupyterLab runtime environment with Poetry and Docker management.
https://github.com/miolab/jupyterlab_poetry
docker jupyterlab nltk poetry python3 pytorch scikit-learn scipy shap xgboost
Last synced: about 2 months ago
JSON representation
JupyterLab runtime environment with Poetry and Docker management.
- Host: GitHub
- URL: https://github.com/miolab/jupyterlab_poetry
- Owner: miolab
- Created: 2020-04-02T08:28:40.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-09-13T10:16:17.000Z (3 months ago)
- Last Synced: 2024-09-14T00:04:28.001Z (3 months ago)
- Topics: docker, jupyterlab, nltk, poetry, python3, pytorch, scikit-learn, scipy, shap, xgboost
- Language: Jupyter Notebook
- Homepage:
- Size: 104 MB
- Stars: 6
- Watchers: 0
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# JupyterLab in Poetry with Docker
Set up a **JupyterLab** runtime environment managed by **Poetry** within **Docker**.
---
## Version Information
- Python & Poetry
```
➜ docker compose run eda python --version
Python 3.12.5
➜ docker compose run eda poetry --version
Poetry (version 1.8.3)
```
- Included libraries
Refer to **pyproject.toml** for details.
## Prerequisites
- Docker and Docker Compose installed.
- This repository is primarily intended for a **Mac** (M1) environment.
## :star: Installation and Usage
- Clone the repository:
```sh
git clone https://github.com/miolab/jupyterlab_poetry.git
```
- Build and start Docker containers:
```sh
cd jupyterlab_poetry
```
```sh
docker compose build
```
```sh
docker compose up
```
- Open JupyterLab in your browser:
- http://localhost:8890/lab
## :star: Adding & Updating Packages
### Add packages
```
docker compose run eda poetry add pyclustering
```
- When also specifying a version:
```
docker compose run eda poetry add pyclustering@^0.10
```
### Preview Updates
```
docker compose run eda poetry update --dry-run
```
### Update packages
```
docker compose run eda poetry update
```
- After updating, rebuild and restart the containers:
```
docker compose build
docker compose up
```
- An example procedure is described here.
- https://github.com/miolab/jupyterlab_poetry/issues/22
---
## Additional information
### Notes
- Poetry is used for package management purposes, and the virtual environment `venv` is avoided.
`poetry config virtualenvs.create false`
### Uninstallation
To delete environment at once and erase directories, execute the following command.
```
docker compose down --rmi all --volumes
cd ../
rm -rf jupyterlab_poetry
```
### References
- Poetry
- [Official](https://python-poetry.org/)
- [The pyproject.toml file](https://python-poetry.org/docs/pyproject/)
- [PyPI](https://pypi.org/project/poetry/)
- [GitHub](https://github.com/python-poetry/poetry)
- Docker
[Docker Official Images / Python](https://hub.docker.com/_/python)