{"id":14007081,"url":"https://github.com/xlwings/xlwings-server-helloworld-fastapi","last_synced_at":"2025-05-04T20:31:19.319Z","repository":{"id":37590960,"uuid":"444355431","full_name":"xlwings/xlwings-server-helloworld-fastapi","owner":"xlwings","description":"Demo repo for the xlwings Server","archived":true,"fork":false,"pushed_at":"2024-09-26T08:37:15.000Z","size":2459,"stargazers_count":19,"open_issues_count":2,"forks_count":18,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-01T00:38:24.603Z","etag":null,"topics":["excel","fastapi","google-sheets","python","xlwings"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/xlwings.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-01-04T09:15:25.000Z","updated_at":"2024-12-18T01:35:53.000Z","dependencies_parsed_at":"2023-11-07T14:49:32.632Z","dependency_job_id":"61d3d777-a6c2-446f-8e1e-d11a70a439c5","html_url":"https://github.com/xlwings/xlwings-server-helloworld-fastapi","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xlwings%2Fxlwings-server-helloworld-fastapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xlwings%2Fxlwings-server-helloworld-fastapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xlwings%2Fxlwings-server-helloworld-fastapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xlwings%2Fxlwings-server-helloworld-fastapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xlwings","download_url":"https://codeload.github.com/xlwings/xlwings-server-helloworld-fastapi/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252395276,"owners_count":21741005,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["excel","fastapi","google-sheets","python","xlwings"],"created_at":"2024-08-10T10:01:48.582Z","updated_at":"2025-05-04T20:31:18.895Z","avatar_url":"https://github.com/xlwings.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"\u003e [!caution]\n\u003e Use https://github.com/xlwings/xlwings-server instead\n\n# xlwings Server: Hello World\n\nThis sample works with:\n\n* Excel on Windows\n* Excel on macOS\n* Excel on the web\n* Google Sheets\n\n## Quickstart\n\n### Run backend server locally\n\nThis is a good option if you want to try the VBA client via `Demo.xlsm`.\n\n* Local Python installation: install the Python dependencies into a virtual env or Conda env by running `pip install -r requirements.txt`, then run `python app/main.py` to run the server\n* Docker: copy `.env.template` to `.env` and enter an xlwings (trial) license key. You can get one from here: https://www.xlwings.org/trial. Then run  `docker compose up`.\n\n### Run backend server via Gitpod\n\nThis is a good option if you want to try out hte Excel Office Scripts or Google Apps Script clients.\n\n* Open this repo in GitPod:    \n[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/xlwings/xlwings-server-helloworld)\n* When you open it the very first time, it will ask you to enter an xlwings (trial) license key. You can get one from here: https://www.xlwings.org/trial\n\n### Clients\n\n* **Excel (via VBA)**:\n  * Local: Once the server is running, you can click the button directly.\n  * GitPod: Open the VBA editor via `Ctrl-F11` (Windows) or `Cmd-F11` (macOS) and replace the URL in `RunRemotePython` with the respective URL that GitPod prints.\n* **Excel (via Office Scripts)**:\n  * Local: You will need to use a tool like ngrok to expose your local server to the internet, see https://docs.xlwings.org/en/latest/pro/server/server.html#part-i-backend\n  * GitPod: In Excel's `Automate` tab, click on `New Script`. Replace the content of the script with the content of `js/xlwings_excel.ts` as you find it in GitPod. `Save` the script, then click on `Run`.\n* **Excel (via Office.js Add-ins)** For Office.js add-ins, please follow this repo instead: https://github.com/xlwings/xlwings-officejs-quickstart\n* **Google Sheets (via Google Apps Script)**:\n  * Local: You will need to use a tool like ngrok to expose your local server to the internet, see https://docs.xlwings.org/en/latest/pro/server/server.html#part-i-backend\n  * GitPod: Click on `Extensions` \u003e `Apps Scripts`. Replace the code in the file `Code.gs` with the code in `js/xlwings_google.js`. Then hit the `Run` button.\n  \n  If you run this the very first time, Google Sheets will ask you for the permissions it needs.\n\nTo learn about how to call your script from a button with Google Sheets or Excel on the web, have a look at the docs (link below).\n\n## Next Steps:\n\n* **Docs**:  \nhttps://docs.xlwings.org/en/stable/pro/server/server.html\n\n* **Authentication**:  \nhttps://docs.xlwings.org/en/stable/pro/server/server_authentication.html\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxlwings%2Fxlwings-server-helloworld-fastapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxlwings%2Fxlwings-server-helloworld-fastapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxlwings%2Fxlwings-server-helloworld-fastapi/lists"}