Skip to main content

Web based code editor on python flask framework

Project description

flaskcode

Build Status PyPI Version MIT License

Web based code editor on python flask framework.

screenshot

Installation

pip install flaskcode

Run application from CLI

Run flaskcode standalone using following command:

flaskcode /path/to/resource/folder

Get help for CLI command:

flaskcode --help
Usage: flaskcode [OPTIONS] [RESOURCE_BASEPATH]

  Run FlaskCode with given RESOURCE_BASEPATH or current working directory.

  All options can be set on the command line or through environment
  variables of the form FLASKCODE_*. For example FLASKCODE_USERNAME.

Options:
  -h, --host TEXT                 IP or hostname on which to run HTTP server.
  -p, --port INTEGER              Port on which to bind HTTP server.
  --username TEXT                 HTTP Basic Auth username.
  --password TEXT                 HTTP Basic Auth password.
  --editor-theme [vs|vs-dark|hc-black]
                                  Editor theme, default is vs-dark.
  --debug                         Run in flask DEBUG mode.
  --env TEXT                      Flask environment, default is development.
  --version                       Show the version and exit.
  --help                          Show this message and exit.

Integrating flaskcode in your Flask app

The flaskcode can be integrated in to your own Flask app by configuring and registering flaskcode.blueprint with your app:

from flask import Flask
import flaskcode

app = Flask(__name__)
app.config.from_object(flaskcode.default_config)
app.config['FLASKCODE_RESOURCE_BASEPATH'] = '/path/to/resource/folder'
app.register_blueprint(flaskcode.blueprint, url_prefix='/flaskcode')

@app.route('/')
def hello():
    return "Hello World!"

if __name__ == '__main__':
    app.run()

Now if you run the Flask app on default port, you can access the flaskcode at http://127.0.0.1:5000/flaskcode.

Built with

Authors

License

This project is licensed under the MIT License - see the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flaskcode-0.0.8.tar.gz (14.5 MB view details)

Uploaded Source

File details

Details for the file flaskcode-0.0.8.tar.gz.

File metadata

  • Download URL: flaskcode-0.0.8.tar.gz
  • Upload date:
  • Size: 14.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.2 CPython/3.8.7

File hashes

Hashes for flaskcode-0.0.8.tar.gz
Algorithm Hash digest
SHA256 2b54abb96d9f17aae047351154d702a6909391b92ceaf2735e061602abd77233
MD5 e05a15075eeacffe7067f5c6d36dd889
BLAKE2b-256 919f1073ae99d867431e018c94f1028897d41f1b7ed1cc5c8d3dbbb4b495b118

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page