Devcontainer support

[jorisroovers]

Allows contributors to get up and running quickly
using github codespaces.

Checklist before requesting a review

• Performed a self-review of my code
• Formatted my code with pkgmt format -> NA
• Added tests (when necessary) -> NA
• Added docstring documentation and update the changelog (when needed) -> Can add more docs if needed but wanted to gauge first whether this is something you're interested in merging.

---

📚 Documentation preview 📚: https://jupysql--484.org.readthedocs.build/en/484/

[idomic]

Can you please also add a changelog entry (with your handle), and some documentation on how to use it here?

[idomic]

Am I testing it the wrong way?
I opened the code spaces and tried running a few python commands in the conda container, but it doesn't seem to recognize JupySQL.

[jorisroovers]

Am I testing it the wrong way? I opened the code spaces and tried running a few python commands in the conda container, but it doesn't seem to recognize JupySQL.

@idomic These work without problems for me (runs, exit code 0, no output, no errors):

❯ conda activate jupysql
❯ python examples/plot_boxplot.py
❯ python /workspaces/jupysql/examples/plot_boxplot.py                                                                                        
❯ python -c "from sql.connection import Connection"

Note that you shouldn’t use /opt/conda/bin/python but just python which will point to the correct conda python environment after you’ve activated it. The jupysql environment has jupysql installed (base does not).

❯ which python
/opt/conda/envs/jupysql/bin/python
# Note that python does NOT point to /opt/conda/bin/python

Both the last 2 python -c statements in your screenshot contain syntax errors which is why they’re not working.

[edublancas]

I've never used codespaces so I'm unfamiliar with the details but let's add some basic tips.

I looked at the pricing and github gives 60 hours monthly for free, but it looks like we have to manually stop it to prevent from going over - so let's add a note on this

is there anything else that's important for people to know?

[edublancas]

relevant link: https://github.com/codespaces - allows managing codespaces

[jorisroovers]

Codespaces by default will shut down after 30 min of idle time. I will add a note on this and link to the codespace docs and pricing.

[jorisroovers]

@edublancas updated the docs based on your comments, but running into an issue with pkgmt setup --doc, see inline reply.

[jorisroovers]

Great, thanks!