adds dev container config & update README

samruddhikhandale · samruddhikhandale · commit d8a58d798130 · 2023-03-03T19:30:46.000Z
tox -e codestyle fix

add ipython

fix "conda install" failure

address comments

Update README.rst

refactor dev container

address feedbacks

address comments
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -0,0 +1,17 @@
+{
+    "name": "AstroPy",
+    "image": "mcr.microsoft.com/devcontainers/miniconda:0-3",
+    "onCreateCommand": "conda init bash && sudo cp .devcontainer/welcome-message.txt /usr/local/etc/vscode-dev-containers/first-run-notice.txt",
+    "postCreateCommand": "git fetch --tag && pip install tox && pip install -e .[all,test_all,docs]",
+    "waitFor": "postCreateCommand",
+    "customizations": {
+        "vscode": {
+            "extensions": [
+                "ms-python.python",
+                "ms-python.black-formatter",
+                "charliermarsh.ruff",
+                "stkb.rewrap"
+            ]
+        }
+    }
+}
diff --git a/.devcontainer/welcome-message.txt b/.devcontainer/welcome-message.txt
@@ -0,0 +1,7 @@
+👋 Welcome to "AstroPy" in GitHub Codespaces!
+
+🛠️  Your environment is fully setup with all the required software.
+
+🔍 To explore VS Code to its fullest, search using the Command Palette (Cmd/Ctrl + Shift + P or F1).
+
+ℹ️  Look at https://docs.astropy.org/en/latest/development/workflow/development_workflow.html for more contribution details.
diff --git a/README.rst b/README.rst
@@ -33,6 +33,19 @@ page. A `summary of contribution guidelines <CONTRIBUTING.md>`_ can also be
 used as a quick reference when you are ready to start writing or validating
 code for submission.
 
+Getting started with GitHub Codespaces
+--------------------------------------
+
+Codespaces is a cloud development environment supported by GitHub. None of the Astropy build machinery depends on it, but it is a convenient way to quickly get started doing development on Astropy.
+
+To get started, create a codespace for this repository by clicking this 👇
+
+|Codespaces|
+
+A codespace will open in a web-based version of Visual Studio Code. The `dev container <.devcontainer/devcontainer.json>`_ is fully configured with software needed for this project. Feel free to take a look at `GitHub Codespaces Support <https://support.github.com/features/codespaces>`_ page for help.
+
+**Note**: Dev containers is an open spec which is supported by `GitHub Codespaces <https://github.com/codespaces>`_ and `other tools <https://containers.dev/supporting>`_.
+
 Supporting the Project
 ----------------------
 
@@ -92,6 +105,10 @@ Astropy is licensed under a 3-clause BSD style license - see the
 .. |Donate| image:: https://img.shields.io/badge/Donate-to%20Astropy-brightgreen.svg
     :target: https://numfocus.salsalabs.org/donate-to-astropy/index.html
 
+.. |Codespaces| image:: https://github.com/codespaces/badge.svg
+    :target: https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=2081289
+    :alt: Open in GitHub Codespaces
+
 
 If you locally cloned this repo before 7 Apr 2021
 -------------------------------------------------
diff --git a/setup.cfg b/setup.cfg
@@ -95,6 +95,7 @@ all =
     typing_extensions>=3.10.0.1
     fsspec[http]>=2022.8.2
     s3fs>=2022.8.2
+    pre-commit
 docs =
     sphinx
     sphinx-astropy>=1.6
