scriptedforms
Quickly create live-update GUIs for Python packages using Markdown and simple HTML elements.
File Explorer
Download Latest Version (.zip)- settings.json
- Dockerfile
- Dockerfile
- docker-compose.yml
- nginx.conf
- README.md
- __init__.py
- data.py
- functions.py
- template-only.md
- __init__.py
- file-change.csv
- file-change.md
- two-columns.md
- __init__.py
- __main__.py
- detailed.md
- example.py
- simple.md
- Apache-2.0
- MANIFEST.in
- README.md
- setup.py
- a-simple-form.md
- a-slider.md
- landing-page.md
- .gitignore
- build-instructions.md
- package.json
- README.md
- scriptedforms.bat
- detailed.png
- quick-start.png
- __init__.py
- LICENSE
- process.py
- __init__.py
- create-your-own-angular-jupyterlab-extension.md
- docs-base.md
- docs.css
- landing-page.md
- before-and-after.ts
- send-token.ts
- .gitignore
- detailed.form.md
- landing-page.md
- landing-page.spec.ts
- protractor.conf.ts
- section-button.md
- section-button.spec.ts
- section-live.md
- section-live.spec.ts
- section-output.md
- section-output.spec.ts
- section-start.md
- section-start.spec.ts
- variable-string.md
- variable-string.spec.ts
- variable-table.csv
- variable-table.md
- variable-table.py
- variable-table.spec.ts
- watchdog-manage.md
- watchdog-template.md
- watchdog-test.spec.ts
- package.json
- run-test.py
- tsconfig.e2e.json
- tsconfig.json
- tslint.json
- yarn.lock
- agree-to-license.md
- pip-freeze.sh
- pypi.sh
- selenium.sh
- travis_install.sh
- travis_script.sh
- wait_for_selenium.sh
- code.component.ts
- code.module.ts
- create-form-component-factory.ts
- form-builder.component.ts
- form-builder.module.ts
- session-start-code.ts
- pandas-table.ts
- slider.ts
- variable-store.ts
- button.component.ts
- live.component.ts
- output.component.ts
- section-base.component.ts
- section-file-change.component.ts
- sections.module.ts
- start.component.ts
- file.service.ts
- form.service.ts
- initialisation.service.ts
- jupyter.service.ts
- kernel.service.ts
- toolbar.service.ts
- variable.service.ts
- watchdog-code.ts
- watchdog.service.ts
- toolbar-base.component.ts
- toolbar-button.component.ts
- toolbar.module.ts
- form-status.ts
- section-component.ts
- variable-component.ts
- variable-value.ts
- conditional.component.ts
- dropdown.component.ts
- number-base.component.ts
- number.component.ts
- slider.component.ts
- string.component.ts
- tick.component.ts
- toggle.component.ts
- variable-base.component.ts
- variable-file.component.html
- variable-file.component.ts
- variable-parameter.component.ts
- variable-table.component.html
- variable-table.component.ts
- variables.module.ts
- app-error-handler.ts
- app.component.html
- app.component.ts
- app.module.ts
- phosphor-angular-loader.ts
- style.css
- widget.ts
- README.md
- landing-page.component.html
- landing-page.component.ts
- doc.component.html
- doc.component.ts
- doc.module.ts
- doc.routing.ts
- style.css
- jupyterlab-plugin.ts
- angular-styles.ts
- angular.ts
- jupyterlab-styles.ts
- jupyterlab.ts
- material.module.ts
- misc.ts
- theme.scss
- app.ts
- component-html.d.ts
- dev.ts
- docs.ts
- main.ts
- polyfills.ts
- public-path.ts
- tsconfig.app.json
- tsconfig.spec.json
- .yarnrc
- __init__.py
- __main__.py
- _scriptedforms_handlers.py
- _utilities.py
- _version.py
- angular.json
- Apache-2.0
- index.html
- package.json
- scriptedforms.json
- scriptedforms.py
- tsconfig.json
- tslint.json
- webpack.config.js
- webpack.dev.js
- webpack.prod.js
- yarn.lock
- .gitignore
- .travis.yml
- Apache-2.0
- Benefits-of-AGPL-3.0+-for-Medical-Physics.md
- code-of-conduct.md
- detailed.form.md
- LICENSE
- MANIFEST.in
- README.md
- setup.py
# Installation Guide
1. Get the code
git clone https://github.com/SimonBiggs/scriptedforms
Downloads the entire project code from GitHub to your computer.
cd scriptedforms
Moves into the project folder you just downloaded.
2. Official Install Script
Easy RecommendedPrerequisites
- Python 3 Python is required to use pip.
pip install scriptedforms
Installs the package published on PyPI directly β no need to clone the source.
After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.
Pulled directly from this repo's README.
3. Docker
EasyPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
β οΈ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
docker compose -f deploy/docker/docker-compose.yml up -d --build
Runs the command against the services defined in the compose file.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
4. Node.js
EasyPrerequisites
yarn
Downloads and installs the libraries listed in package.json.
yarn build
Builds optimized production files.
yarn pip:install
Type this command into your terminal and run it.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
Pulled directly from this repo's README.
5. Python
EasyPrerequisites
pip install scriptedforms
Installs the package published on PyPI directly β no need to clone the source.
jupyter serverextension enable --py scriptedforms
Type this command into your terminal and run it.
jupyter notebook --NotebookApp.default_url=/scriptedforms/use/quick-start.md
Launches Jupyter in your browser so you can open and run the notebook (.ipynb) files.
yarn pip:install
Type this command into your terminal and run it.
If it runs without errors and prints output in the terminal, it worked.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)