Add dev-containers and their environment #33

gastonsalgueiro · 2024-11-21T14:20:48Z

Type of change

Fix
Story
Chore

Description of the change

The VS Code dev-containers are added. Everything related and necessary is placed in the .devcontainers folder. Then, I delete everything we previously had related to Docker, as it is no longer needed to bring up the template, and in a future PR, this will be rethought.

Also, some necessary modifications are made due to the dev-containers, for example, the README.d is adjusted, and the exec.sh file is modified.

Related PRs

N/A

.devcontainer/docker-compose.yaml

jrg091 · 2024-11-21T14:40:51Z

README.md

-To start the containers, just run `docker-compose up` (or `docker-compose up -d` if you want to run the containers in background); or `docker-compose create` and `docker-compose start` if you don't want to see the logs. 
-Once the containers are running, you can go to `http://localhost:8000/docs` to see the automatic interactive API documentation.
+
+The only things you need are [Docker](https://docs.docker.com/engine/install/), [Docker Compose](https://docs.docker.com/compose/install/), and [Visual Studio Code](https://code.visualstudio.com/download). Once you open the template with VS Code, it will recommend that you install the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) if you don’t have it already. Then, a pop-up will appear to reopen the template in the devcontainer, or you can use `Ctrl / Cmd + shift + P` -> `Dev Containers: Open Folder in Container…`.


Suggested change

The only things you need are [Docker](https://docs.docker.com/engine/install/), [Docker Compose](https://docs.docker.com/compose/install/), and [Visual Studio Code](https://code.visualstudio.com/download). Once you open the template with VS Code, it will recommend that you install the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) if you don’t have it already. Then, a pop-up will appear to reopen the template in the devcontainer, or you can use `Ctrl / Cmd + shift + P` -> `Dev Containers: Open Folder in Container…`.

The only things you need are [Docker](https://docs.docker.com/engine/install/), [Docker Compose](https://docs.docker.com/compose/install/), and a code editor with devcontainer support like [Visual Studio Code](https://code.visualstudio.com/download). Once you open the template with VS Code, it will recommend that you install the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) if you don’t have it already. Then, a pop-up will appear to reopen the template in the devcontainer, or you can use `Ctrl / Cmd + shift + P` -> `Dev Containers: Open Folder in Container…`.

jrg091 · 2024-11-21T14:42:59Z

README.md

+
+Once the containers and server are running, you can go to `http://localhost:8000/docs` to see the automatic interactive API documentation.
+
+In case you don't to use VS Code and dev containers, or you want to set up the environment in a different way. You must have `Python >3.11`, [Poetry](https://python-poetry.org/docs/#installation) (don't forget to install the dependencies from the lock file), and a [PostgreSQL](https://www.postgresql.org/) database, setting the corresponding environment variables for the database connection.


nit.... lists help me to follow steps 😅

Suggested change

In case you don't to use VS Code and dev containers, or you want to set up the environment in a different way. You must have `Python >3.11`, [Poetry](https://python-poetry.org/docs/#installation) (don't forget to install the dependencies from the lock file), and a [PostgreSQL](https://www.postgresql.org/) database, setting the corresponding environment variables for the database connection.

In case you don't to use VS Code and dev containers, or you want to set up the environment in a different way. You must have

- `Python >3.11`

- [Poetry](https://python-poetry.org/docs/#installation) (don't forget to install the dependencies from the lock file)

- [PostgreSQL](https://www.postgresql.org/) database, setting the corresponding environment variables for the database connection.

MBerguer · 2024-11-21T14:59:33Z

.devcontainer/Dockerfile

@@ -0,0 +1,10 @@
+FROM python:3.11-slim


I saw in the other PR @marianogigli is trying to update it to 3.13 https://github.com/xmartlabs/python-template/pull/32/files#diff-dd2c0eb6ea5cfc6c4bd4eac30934e2d5746747af48fef6da689e85b752f39557L1

did you have a chance to try it here, too?

Maybe we can include the upgrade for python in this PR and check if everything works as expected.
What do you think?

Yep, sounds good

pgrill · 2024-11-25T19:10:41Z

.devcontainer/Dockerfile

@@ -0,0 +1,10 @@
+FROM python:3.11-slim


Maybe we can include the upgrade for python in this PR and check if everything works as expected.
What do you think?

pgrill · 2024-11-25T19:22:27Z

.dockerignore

Shouldn´t we include the .dockerignore file in the .devcontainer file?

For the context of devcontainers, I'm not sure if it's worth it because we're mounting the entire repo as a volume, and we're not doing any COPY or anything similar. Maybe when we add other Dockerfiles it will be worth it, but I'm not sure if I explained myself well or what do you think?

pgrill · 2024-11-25T19:27:33Z

.devcontainer/docker-compose.yaml

@@ -0,0 +1,26 @@
+services:
+  devcontainer:


what do you think about include the env_file attribute in case someone whats to add new variables in their project?

I added the env vars using the property containerEnv of the devcontainers.json file. New ones can be added there, or we can use "runArgs": ["--env-file",".devcontainer/env_file.env"] to add them from a file (or in the docker-compose), or we can do both to have an example. What do you prefer?

I would suggest defining it here as more people will know where to look for it. Also one question, is env variables interpolation available if you define it in the json file? That may be another reason for having it in an .env file

envfile added. If the same variable is defined in both the .env file and the .json file, for example, the devcontainer will take the value from the json file

MBerguer · 2025-01-15T15:51:08Z

Dockerfile

@@ -0,0 +1,25 @@
+FROM python:3.11-slim


Did you try 3.13 here as well?

NICE CATCH, I just restored the file and forgot to update the version

jrg091 · 2025-01-15T16:19:33Z

.devcontainer/.env.example

 LOG_LEVEL=DEBUG
 SERVER_URL=example.com
 ACCESS_TOKEN_EXPIRE_MINUTES=15
-JWT_SIGNING_KEY=
+JWT_SIGNING_KEY=


Suggested change

JWT_SIGNING_KEY=

JWT_SIGNING_KEY=

jrg091 · 2025-01-15T16:36:26Z

.devcontainer/devcontainer.json

+    ],
+    "unwantedRecommendations": []
+  },
+  "postCreateCommand": "cat /workspace/.devcontainer/aliases-devcontainer >> ~/.bashrc",


jrg091 · 2025-01-15T16:37:31Z

.devcontainer/devcontainer.json

+  "forwardPorts": [
+    // Backend API:
+    //   localhost:8000
+    "devcontainer:8000",
+    // Postgres:
+    //   localhost:5432 for accessing postgres via local dbeaver/psql client
+    "postgres:5432"


Suggested change

"forwardPorts": [

// Backend API:

// localhost:8000

"devcontainer:8000",

// Postgres:

// localhost:5432 for accessing postgres via local dbeaver/psql client

"postgres:5432"

"forwardPorts": [

// Backend API:

// localhost:8000 for accessing on your host

"devcontainer:8000",

// Postgres:

// localhost:5432 for accessing postgres via local dbeaver/psql client

"postgres:5432"

src/admin.py

federicoVallcorbaX · 2025-01-15T19:52:39Z

❤️

gastonsalgueiro added 2 commits November 21, 2024 11:10

Add dev-containers and their environment

dfbf77b

types-mock and remove unused command from exec.sh

7ced3c5

jrg091 reviewed Nov 21, 2024

View reviewed changes

.devcontainer/docker-compose.yaml Show resolved Hide resolved

jrg091 reviewed Nov 21, 2024

View reviewed changes

MBerguer reviewed Nov 21, 2024

View reviewed changes

pgrill reviewed Nov 25, 2024

View reviewed changes

gastonsalgueiro added 3 commits November 28, 2024 16:10

pr feedback

36b4ecc

add cache

bb24128

env file

e419fe8

marianogigli mentioned this pull request Jan 15, 2025

Template update python version #32

Closed

3 tasks

gastonsalgueiro added 2 commits January 15, 2025 11:45

restore dockerfile

c60682d

update readme and fix admin.py bug

781493f

MBerguer reviewed Jan 15, 2025

View reviewed changes

update root dokcerfile

d07bf58

gastonsalgueiro requested a review from m-revetria January 15, 2025 15:55

jrg091 reviewed Jan 15, 2025

View reviewed changes

gastonsalgueiro added 2 commits January 15, 2025 13:37

eol

49e561b

pr feedback

8332efb

jrg091 reviewed Jan 15, 2025

View reviewed changes

src/admin.py Show resolved Hide resolved

jrg091 approved these changes Jan 15, 2025

View reviewed changes

m-revetria approved these changes Jan 15, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add dev-containers and their environment #33

Add dev-containers and their environment #33

gastonsalgueiro commented Nov 21, 2024 •

edited

Loading

jrg091 Nov 21, 2024

jrg091 Nov 21, 2024

MBerguer Nov 21, 2024 •

edited

Loading

pgrill Nov 25, 2024

gastonsalgueiro Nov 27, 2024

pgrill Nov 25, 2024

pgrill Nov 25, 2024

gastonsalgueiro Nov 27, 2024

pgrill Nov 25, 2024

gastonsalgueiro Nov 27, 2024 •

edited

Loading

jrg091 Dec 27, 2024

gastonsalgueiro Jan 15, 2025

MBerguer Jan 15, 2025

gastonsalgueiro Jan 15, 2025

jrg091 Jan 15, 2025

jrg091 Jan 15, 2025

jrg091 Jan 15, 2025

federicoVallcorbaX commented Jan 15, 2025


		Once the containers and server are running, you can go to `http://localhost:8000/docs` to see the automatic interactive API documentation.

		In case you don't to use VS Code and dev containers, or you want to set up the environment in a different way. You must have `Python >3.11`, [Poetry](https://python-poetry.org/docs/#installation) (don't forget to install the dependencies from the lock file), and a [PostgreSQL](https://www.postgresql.org/) database, setting the corresponding environment variables for the database connection.

Add dev-containers and their environment #33

Are you sure you want to change the base?

Add dev-containers and their environment #33

Conversation

gastonsalgueiro commented Nov 21, 2024 • edited Loading

Type of change

Description of the change

Related PRs

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MBerguer Nov 21, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gastonsalgueiro Nov 27, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

federicoVallcorbaX commented Jan 15, 2025

gastonsalgueiro commented Nov 21, 2024 •

edited

Loading

MBerguer Nov 21, 2024 •

edited

Loading

gastonsalgueiro Nov 27, 2024 •

edited

Loading