Skip to content

Commit

Permalink
docs(readme): add "Open in Codespaces" button
Browse files Browse the repository at this point in the history
* feat-dev-container

* point to repo and remove extra stuff

* specify machine config

* point to branch

* point to main repo
  • Loading branch information
john0isaac authored Dec 22, 2023
1 parent d7995e8 commit 4f474bc
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 0 deletions.
24 changes: 24 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
// Adopting the default GitHub codespaces-jupyter template as starter
// https://github.com/github/codespaces-jupyter

{
"name" : "Sec Parser",
"image": "mcr.microsoft.com/devcontainers/universal:2",
"hostRequirements": {
"cpus": 4
},
"waitFor": "onCreateCommand",
"updateContentCommand": "python3 -m pip install -r .devcontainer/requirements.txt",
"postCreateCommand": "",
"customizations": {
"codespaces": {
"openFiles": ["./docs/source/notebooks/user_guide.ipynb"]
},
"vscode": {
"extensions": [
"ms-toolsai.jupyter",
"ms-python.python"
]
}
}
}
3 changes: 3 additions & 0 deletions .devcontainer/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
ipywidgets==7.7.1
sec-parser
sec_downloader
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,8 @@ This project, `sec-parser`, is an independent, open-source initiative and has no

This guide will walk you through the process of installing the `sec-parser` package and using it to extract the "Segment Operating Performance" section as a semantic tree from the latest Apple 10-Q filing.

[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/alphanome-ai/sec-parser?devcontainer_path=.devcontainer/devcontainer.json)

## Installation

First, install the `sec-parser` package using pip:
Expand Down

0 comments on commit 4f474bc

Please sign in to comment.