https://github.com/terasakisatoshi/jldev_poetry_2023

jldev_poetry 2023 version
https://github.com/terasakisatoshi/jldev_poetry_2023

Last synced: 3 days ago
JSON representation

jldev_poetry 2023 version

• Host: GitHub
• URL: https://github.com/terasakisatoshi/jldev_poetry_2023
• Owner: terasakisatoshi
• License: mit
• Created: 2023-10-19T04:29:26.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-02T16:46:19.000Z (2 months ago)
• Last Synced: 2024-10-12T12:40:01.047Z (about 1 month ago)
• Language: Dockerfile
• Size: 1.06 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# jldev_poetry

Enhance your JOps (= Julia + Python/Poetry + VSCode + JupyterLab + Docker + Pluto)

# How to use

## Prerequisite

- Please install Git, GNU Make, Docker and Docker Compose.

## Setup environment

```console

$ git clone https://github.com/terasakisatoshi/jldev_poetry.git

$ cd jldev_poetry

$ make

```

After that go to the next chapter.

# How to run

## Initialize JupyterLab

```console

$ docker-compose up lab

```

## Dive into the Docker container

```console

$ docker-compose run --rm shell bash

jovyan@e74b3f5d0d5e:/workspace/jldev_poetry.jl$ # do something awesome e.g. julia or python

```

## Test

```console

$ make test

```

## Docs

```console

$ docker-compose up web

```

Then, go to localhost:8000

## Format file

```console

docker-compose run --rm shell poe format

```

## Update packages

- Julia

```console

$ docker-compose run --rm shell julia -e 'using Pkg; Pkg.add("Example")'

$ make # rebuild Docker image

```

- Python

```console

$ docker-compose run --rm shell poetry add "numpy"

$ make # rebuild Docker image

```

## VSCode

- Install VSCode in advance

```console

$ cd /path/to/this/repository

$ code . # Open VSCode

```

Then dive into Remote Container.

## Clean up

```console

$ make clean

```