-
Notifications
You must be signed in to change notification settings - Fork 3
Quick Start
itzmetanjim edited this page Jul 1, 2025
·
4 revisions
This guide provides a quick overview of how to get started with PyPositron.
Install PyPositron using pip:
pip install py-positron
In Linux, you may need to do more steps. See Installation
Run the following command to create a new project:
positron create
Follow the prompts to set up your project directory, name, author, and description.
If you specified a directory:
cd your_project_directory
After creation, your project directory will typically have the following structure:
your_project_name/
├── config.json
├── LICENSE
├── backend/
│ └── main.py
├── frontend/
│ ├── index.html
│ └── checkmark.png
└── winvenv/ or linuxvenv/ if created
└── ... (virtual environment files)
-
config.json
: Contains project metadata and configuration. -
LICENSE
: The project's license file (MIT by default). -
backend/main.py
: Your main Python application logic. This is the entry point for your application. -
frontend/index.html
: Your main HTML file for the user interface. -
frontend/checkmark.png
: An example image used in the defaultindex.html
. -
winvenv/
orlinuxvenv/
: The virtual environment for your project, if you chose to create one.
Run the following command to start your application:
positron start
This will open the UI window defined in your backend/main.py
file, loading frontend/index.html
by default.
- Getting Started: Make an example code editor app.