Ask Documentation
WebsiteGitHubPyPI
  • Introduction
  • Getting Started
    • Install & Get Started
    • Hello, World!
  • Routes & Requests
    • Routes
    • Defining Routes
    • Request Data
    • HTTP Status Codes & Methods
    • CORS
  • Response
    • JSON Response
    • JSON Response With an HTTP Status Code
  • Classes
    • Class Instance Variable
    • Initialization/Constructor Method
  • Data Types
    • Dictionaries
  • Built-in Utilities
    • Quick_set()
    • Deep()
    • Serialize()
    • Require_keys()
    • Random Generators
    • Pattern Matching
    • Email
  • Database
    • Ask and Databases
    • Models/Classes
      • Columns
      • Initialization/Constructor
      • Serialization
      • The &basic decorator
    • CRUD
      • Add
      • Select
      • Update
      • Delete
    • Check if a Row Exists
    • Sorting
    • Database Lists
  • JWT Authentication
    • Introduction
    • Protecting Routes
    • How to Create a Basic Login System
    • Properties & Methods of _auth
    • Making Requests to Protected Routes
  • Decorators
    • What are Decorators?
    • Create and Use Custom Decorators
    • Built-in Decorators
  • Security
    • Hashing
    • Route Security
    • Environment Variables
  • Configuring the Transpiler
  • Askfile.toml
  • Modules & Libraries
    • Importing an Ask Module
    • Includes
    • Importing Python Modules
  • Development Tools
    • Editor Syntax Highlighting
    • Automatic API documentation
    • CLI Flags
    • Running in development mode
    • Versioning System
  • Contribute
    • Feature Requests
    • Bug Reports
    • Contribute Code
Powered by GitBook
On this page
Export as PDF
  1. Getting Started

Install & Get Started

How to install Ask.

PreviousIntroductionNextHello, World!

Last updated 4 years ago

Setup a Development Environment for Ask.

We recommend that you always create a Python virtual environment for your Ask projects. This way you can always use the correct version of Ask for every project. If you use it globally and then upgrade Ask, previous features might break. You can learn more about Ask's versioning system , and more about virtual environments .

  • Create a new folder.

  • Create a new Python virtual environment:

    • $ python3 -m venv venv

  • Activate it:

    • $ source venv/bin/activate

  • Install Ask.

    • $ pip install ask-lang

  • Create a .ask file to hold your app.

  • Run it with:

    • $ ask [your app].ask

We recommend that you use pipx to install Ask if you want to use it globally, but you can also use pip to intall it without a virtual environment.

here
here