Frappe Framework

https://docs.frappe.io/framework/user/en/
Admin
Frappe Framework is a full-stack web application framework built with Python and JavaScript for...
Tokens:288,451
Snippets:2,786
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Example: bench version --format plain

Source: https://docs.frappe.io/framework/user/en/bench/reference/bench-version

Example command to get human-readable information about installed apps on the current bench, including commit messages.

```bash
bench version --format plain
```

--------------------------------

### Setup sites and apps with bench

Source: https://docs.frappe.io/framework/user/en/production-setup

Sets up a new site and installs apps. Creates a site named example.com, downloads the erpnext app and a custom app from a Git repository, then installs both apps on the site.

```bash
# change directory to frappe-bench
cd frappe-bench

# create a new site
bench new-site example.com

# download frappe apps or your custom-apps
bench get-app erpnext
bench get-app https://github.com/yourremote/yourapp.git

# install apps onto your site
bench --site example.com install-app erpnext yourapp
```

--------------------------------

### Example: bench version -f json

Source: https://docs.frappe.io/framework/user/en/bench/reference/bench-version

Example command to get bench version information in JSON format using the short flag -f.

```bash
bench version -f json
```

--------------------------------

### modules.txt example

Source: https://docs.frappe.io/framework/user/en/guides/basics/apps

Example modules.txt content showing modules for the ERPNext app. Modules organize Documents and each gets an icon on the Desk.

```text
 accounts
 buying
 home
 hr
 manufacturing
 projects
 selling
 setup
 stock
 support
 utilities
 contacts
```

--------------------------------

### Setup Bench Manager on an existing bench

Source: https://docs.frappe.io/framework/user/en/bench/bench-commands

Run this command on an existing bench to install Bench Manager. It creates a new site bench-manager.local, fetches the bench_manager app, and installs the app on that site, which you can then manage via the /desk view.

```zsh
➜ bench setup manager
```

--------------------------------

### Initialize MySQL server setup on macOS

Source: https://docs.frappe.io/framework/user/en/installation

Initializes MySQL server setup if not prompted for root password during installation. Only run if not prompted.

```bash
sudo mariadb-secure-installation
```

--------------------------------

### Install app on site

Source: https://docs.frappe.io/framework/user/en/tutorial/create-a-site

Install the Library Management app on the site. The output shows the installation progress.

```bash
$ bench --site library.localhost install-app library_management

Installing library_management...
```

--------------------------------

### Open bench console for a site

Source: https://docs.frappe.io/framework/user/en/debugging

Starts an iPython shell for the specified site, importing frappe and connecting to the database. The output shows an example of fetching a document and its representation.

```bash
▶ bench --site [sitename] console

In [1]: frappe.get_doc('Task', 'TASK00004')
Out[1]: <erpnext.projects.doctype.task.task.task at="" 0x10825d710="">
  
```

--------------------------------

### Start bench with start

Source: https://docs.frappe.io/framework/user/en/bench/bench-commands

Starts the bench development server. After starting, access the site at localhost:8000 (or your external IP). Default login is Administrator with the password set during site creation.

```zsh
➜ bench start
```

--------------------------------

### Install an app with bench install-app

Source: https://docs.frappe.io/framework/user/en/guides/basics/apps

Command to install an app to a site.

```bash
 bench --site site_name install-app app_name
```

--------------------------------

### Create a new site and install an app

Source: https://docs.frappe.io/framework/user/en/bench/reference/new-site

Creates a new site and installs an app that is available on the current bench.

```bash
bench new-site {site} --install-app {app}
```

--------------------------------

### bench setup command usage

Source: https://docs.frappe.io/framework/user/en/bench/bench-commands

General usage for the setup command group. Use this to run any setup subcommand within the current bench context.

```zsh
➜ bench setup COMMAND [ARGS]...
```

--------------------------------

### Interactive prompts and installation output for bench new-app

Source: https://docs.frappe.io/framework/user/en/tutorial/create-an-app

Shows the prompts you will see when creating an app, followed by the installation output. The app is created in the apps folder and installed with pip and bench build.

```bash
App Title (default: Library Management):
App Description: Library Management System
App Publisher: Faris Ansari
App Email: faris@example.com
App Icon (default 'octicon octicon-file-directory'):
App Color (default 'grey'):
App License (default 'MIT'):
'library_management' created at /home/frappe/frappe-bench/apps/library_management

Installing library_management
$ ./env/bin/pip install -q -U -e ./apps/library_management
$ bench build --app library_management
yarn run v1.22.4
$ FRAPPE_ENV=production node rollup/build.js --app library_management
Production mode
✔ Built js/moment-bundle.min.js
✔ Built js/libs.min.js
✨  Done in 1.95s.
```

--------------------------------

### Install bench CLI with uv

Source: https://docs.frappe.io/framework/user/en/installation

Installs the bench CLI via pip using uv.

```bash
uv tool install frappe-bench
```

--------------------------------

### Install an app with bench install-app

Source: https://docs.frappe.io/framework/user/en/bench/frappe-commands

Installs a Frappe application on the specified site. The app must already be available on the bench.

```bash
bench --site {site} install-app {app}
```

--------------------------------

### Example: set users limit

Source: https://docs.frappe.io/framework/user/en/bench/guides/settings-limits

Example command that sets the users limit to 5 for the site site1.local.

```bash
bench --site site1.local set-limit users 5
```

--------------------------------

### Install Bench with Easy Install script

Source: https://docs.frappe.io/framework/user/en/production-setup

Installs bench with the --production flag on supported Linux distributions (Debian, Ubuntu, CentOS). Replace [frappe-user] with the desired user.

```bash
sudo python install.py --production --user [frappe-user]
```

--------------------------------

### After instrumentation example

Source: https://docs.frappe.io/framework/user/en/ui-testing

Example of source code after instrumentation with Istanbul, showing inserted counters.

```bash
cov_1m1jljnmzu();

function foo(a, b) {
 cov_1m1jljnmzu().f[0]++;
 cov_1m1jljnmzu().s[0]++;

 if (a < b) {
 cov_1m1jljnmzu().b[0][0]++;
 cov_1m1jljnmzu().s[1]++;
 return b - a;
 } else {
 cov_1m1jljnmzu().b[0][1]++;
 cov_1m1jljnmzu().s[2]++;
 return a - b;
 }
}
```

--------------------------------

### Install hooks: before_install, after_install, after_sync

Source: https://docs.frappe.io/framework/user/en/python-api/hooks

Install hooks allow running code before and after app installation. The hooks.py file defines module paths to functions in app/setup/install.py that execute at each stage.

```python
# python module path
before_install = "app.setup.install.before_install"
after_install = "app.setup.install.after_install"
after_sync = "app.setup.install.after_sync"
  
```

```python
# will run before app is installed on site
def before_install():
    pass

# will run after app is installed on site
def after_install():
    pass

# will run after app fixtures are synced
def after_sync():
    pass
  
```

--------------------------------

### Install app with install-app

Source: https://docs.frappe.io/framework/user/en/bench/bench-commands

Installs an app on a specific site. Use the --site flag to specify the target site.

```zsh
➜ bench --site site1.local install-app erpnext
```

--------------------------------

### bench install command usage

Source: https://docs.frappe.io/framework/user/en/bench/bench-commands

General usage for the install command group. Use this to install system dependencies for setting up a Frappe environment.

```zsh
 bench install COMMAND [ARGS]...
```

--------------------------------

### Before instrumentation example

Source: https://docs.frappe.io/framework/user/en/ui-testing

Example of source code before instrumentation for code coverage.

```bash
function foo(a, b) {
 if (a < b)
 return b - a;
 else
 return a - b;
}
```

--------------------------------

### Run bench start command

Source: https://docs.frappe.io/framework/user/en/debugging

The bench start command initiates all processes defined in the Procfile and displays their logs in the terminal.

```bash
▶ bench start
14:55:17 system | redis_cache.1 started (pid=4085)
14:55:17 system | redis_socketio.1 started (pid=4086)
14:55:17 system | redis_queue.1 started (pid=4088)
14:55:17 system | web.1 started (pid=4089)
14:55:17 system | socketio.1 started (pid=4090)
14:55:17 system | watch.1 started (pid=4094)
14:55:17 system | worker_short.1 started (pid=4096)
14:55:17 system | schedule.1 started (pid=4095)
14:55:17 redis_queue.1 | 4088:C 22 May 14:55:17.257 # oO0OoO0OoO0Oo Redis is starting oO0OoO0OoO0Oo
14:55:17 redis_queue.1 | 4088:C 22 May 14:55:17.264 # Redis version=4.0.11, bits=64, commit=00000000, modified=0, pid=4088, just started
14:55:17 redis_queue.1 | 4088:C 22 May 14:55:17.264 # Configuration loaded
14:55:17 redis_queue.1 | 4088:M 22 May 14:55:17.265 * Increased maximum number of open files to 10032 (it was originally set to 4864).
14:55:17 redis_cache.1 | 4085:C 22 May 14:55:17.262 # oO0OoO0OoO0Oo Redis is starting oO0OoO0OoO0Oo
14:55:17 redis_cache.1 | 4085:C 22 May 14:55:17.268 # Redis version=4.0.11, bits=64, commit=00000000, modified=0, pid=4085, just started
14:55:17 redis_cache.1 | 4085:C 22 May 14:55:17.268 # Configuration loaded
14:55:17 redis_cache.1 | 4085:M 22 May 14:55:17.269 * Increased maximum number of open files to 10032 (it was originally set to 4864).
14:55:17 redis_socketio.1 | 4086:C 22 May 14:55:17.262 # oO0OoO0OoO0Oo Redis is starting oO0OoO0OoO0Oo
14:55:17 redis_socketio.1 | 4086:C 22 May 14:55:17.270 # Redis version=4.0.11, bits=64, commit=00000000, modified=0, pid=4086, just started
14:55:17 redis_socketio.1 | 4086:C 22 May 14:55:17.270 # Configuration loaded
14:55:17 redis_socketio.1 | 4086:M 22 May 14:55:17.272 * Increased maximum number of open files to 10032 (it was originally set to 4864).
14:55:17 redis_queue.1 | 4088:M 22 May 14:55:17.285 * Running mode=standalone, port=11002.
14:55:17 redis_queue.1 | 4088:M 22 May 14:55:17.285 # Server initialized
14:55:17 redis_queue.1 | 4088:M 22 May 14:55:17.286 * Ready to accept connections
14:55:17 redis_cache.1 | 4085:M 22 May 14:55:17.287 * Running mode=standalone, port=13002.
14:55:17 redis_cache.1 | 4085:M 22 May 14:55:17.292 # Server initialized
14:55:17 redis_cache.1 | 4085:M 22 May 14:55:17.292 * Ready to accept connections
14:55:17 redis_socketio.1 | 4086:M 22 May 14:55:17.294 * Running mode=standalone, port=12002.
14:55:17 redis_socketio.1 | 4086:M 22 May 14:55:17.294 # Server initialized
14:55:17 redis_socketio.1 | 4086:M 22 May 14:55:17.295 * Ready to accept connections
14:55:17 system | worker_long.1 started (pid=4098)
14:55:17 system | worker_default.1 started (pid=4100)
14:55:18 socketio.1 | listening on *: 9002
14:55:20 socketio.1 | { Error: connect ECONNREFUSED 0.0.0.0:8002
14:55:20 socketio.1 | at TCPConnectWrap.afterConnect [as oncomplete] (net.js:1191:14)
14:55:20 socketio.1 | errno: 'ECONNREFUSED',
14:55:20 socketio.1 | code: 'ECONNREFUSED',
14:55:20 socketio.1 | syscall: 'connect',
14:55:20 socketio.1 | address: '0.0.0.0',
14:55:20 socketio.1 | port: 8002,
14:55:20 socketio.1 | response: undefined }
14:55:24 web.1 | * Running on http://0.0.0.0:8002/ (Press CTRL+C to quit)
14:55:24 web.1 | * Restarting with fsevents reloader
14:55:24 watch.1 | yarn run v1.10.1
14:55:24 watch.1 | $ node rollup/watch.js
14:55:25 web.1 | * Debugger is active!
14:55:25 web.1 | * Debugger PIN: 321-355-865
14:55:26 watch.1 |
14:55:26 watch.1 | Rollup Watcher Started
14:55:26 watch.1 |
14:55:26 watch.1 | Watching...
14:55:26 watch.1 | Rebuilding frappe-web.css
14:55:27 watch.1 | Rebuilding frappe-web-b4.css
14:55:27 watch.1 | Rebuilding chat.js
14:55:28 web.1 |
14:55:28 web.1 | test print
```

--------------------------------

### Dynamic route pattern example

Source: https://docs.frappe.io/framework/user/en/python-api/hooks

Example of a dynamic route where <name> is the dynamic part but the same profile page is rendered.

```text
/profile/<name>
```

--------------------------------

### Configure role-based homepage with role_home_page

Source: https://docs.frappe.io/framework/user/en/python-api/hooks

Sets role-based homepages: users with the Customer role get /orders, and users with the Supplier role get /bills.

```python
role_home_page = {
    "Customer": "orders",
    "Supplier": "bills"
}
```

--------------------------------

### Session hook method in app/overrides.py

Source: https://docs.frappe.io/framework/user/en/python-api/hooks

Example method for the on_session_creation hook. It receives the login_manager argument and can allocate free credits to the session user.

```python
def allocate_free_credits(login_manager):
    # allocate free credits to frappe.session.user
    pass
```

--------------------------------

### Export fixtures with bench export-fixtures

Source: https://docs.frappe.io/framework/user/en/python-api/hooks

Define a fixtures hook to export all records from the Category doctype, then run the bench command to generate JSON files for each doctype. This syncs database records when installing or updating a site.

```python
fixtures = [
    # export all records from the Category table
    "Category"
]
```

```bash
bench --site sitename export-fixtures
```

--------------------------------

### Install an app on a site with bench install-app

Source: https://docs.frappe.io/framework/user/en/basics/apps

Installs the app on a site, creating the models and database tables for the app. Run this command to use the app on the specified site.

```sh
$ bench --site site_name install-app custom_app

Installing custom_app...
```

--------------------------------

### Show bench init help

Source: https://docs.frappe.io/framework/user/en/bench/bench-commands

Use `bench init --help` to see options for initializing a new bench instance. The output shows the `--python`, `--ignore-exist`, and `--apps_path` flags.

```zsh
➜ bench init --help
Usage: bench init [OPTIONS] PATH

 Initialize a new bench instance in the specified path

Options:
 --python TEXT Path to Python Executable.
 --ignore-exist Ignore if Bench instance exists.
 --apps_path TEXT path to json files with apps to install
 after init
```

--------------------------------

### More bench execute examples

Source: https://docs.frappe.io/framework/user/en/bench/reference/execute

A collection of additional bench execute examples covering common Frappe operations: clearing cache, getting documents, counting records, running whitelisted methods, checking record existence, getting configuration values, executing DocType methods, and chaining operations.

```bash
# Clear cache for a specific DocType
bench --site frappe.test execute frappe.clear_cache --doctype "Sales Order"

# Get a document
bench --site frappe.test execute frappe.get_doc User Administrator

# Count records
bench --site frappe.test execute frappe.db.count User

# Run a whitelisted method
bench --site frappe.test execute myapp.api.my_function --param1 value1 --param2 value2

# Check if a record exists
bench --site frappe.test execute frappe.db.exists User guest

# Get configuration value
bench --site frappe.test execute frappe.conf.get developer_mode

# Execute a DocType method
bench --site frappe.test execute "frappe.get_doc('User', 'Administrator').get_fullname()"

# Chain operations with Python expressions
bench --site frappe.test execute "frappe.get_doc('User', 'Administrator').add_roles('System Manager')"
```

--------------------------------

### Create a new bench with init

Source: https://docs.frappe.io/framework/user/en/bench/bench-commands

Initializes a new bench directory with the Frappe framework installed and sets up periodic backups. Run this command first to create your bench environment.

```zsh
➜ bench init frappe-bench && cd frappe-bench
```

--------------------------------

### Configure Grafana systemd service

Source: https://docs.frappe.io/framework/user/en/using_frappe_as_oauth_service

Use these systemd commands to enable Grafana to start on boot, start the service, and check its status. Run them after installing Grafana on a Debian-based system.

```bash
# add to systemd to start on bootup
systemctl enable grafana-server.service
# start the service
systemctl start grafana-server
# check status
systemctl status grafana-server
  
```

--------------------------------

### Initialize a new frappe-bench setup

Source: https://docs.frappe.io/framework/user/en/basics/architecture

Initializes a new frappe-bench directory with the specified name, setting up the directory structure, virtual environment, configuration, and dependencies.

```sh
bench init frappe-bench
```

--------------------------------

### doc.get_url - Get Desk URL

Source: https://docs.frappe.io/framework/user/en/api/document

Returns the Desk URL for the document, for example `/app/task/TASK00002`.

```python
url = doc.get_url()
  
```

--------------------------------

### GET /api/resource/Customer/CUST-00001

Source: https://docs.frappe.io/framework/user/en/guides/integration/rest_api/manipulating_documents

Retrieves a specific Customer document by its name (ID) CUST-00001. Authentication is required but not shown in this example.

```bash
curl -X GET https://{your frappe instance}/api/resource/Customer/CUST-00001
```

--------------------------------

### Import dayjs in main.bundle.js

Source: https://docs.frappe.io/framework/user/en/basics/asset-bundling

Import and use the dayjs library in your source files after installing it with yarn. This example is from myapp/public/main.bundle.js.

```js
import * as dayjs from 'dayjs';

console.log(dayjs())
```

--------------------------------

### Example site_config.json

Source: https://docs.frappe.io/framework/user/en/basics/sites

Example site_config.json file containing database and admin credentials. Values are available in the frappe.conf local variable as a dict.

```json
{
    "db_name": "test_frappe",
    "db_password": "test_frappe",
    "admin_password": "admin",
}
  
```

--------------------------------

### Multiple Extensions for a DocType

Source: https://docs.frappe.io/framework/user/en/python-api/hooks

Define multiple extensions for the same DocType using the `extend_doctype_class` hook. This example shows `ValidationMixin` applied to both Address and Contact, while `GeocodingMixin` is only applied to Address.

```python
extend_doctype_class = {
    "Address": [
        "app.extensions.address.GeocodingMixin",
        "app.extensions.common.ValidationMixin"
    ],
    "Contact": [
        "app.extensions.common.ValidationMixin"
    ]
}

```

--------------------------------

### Create first bench instance

Source: https://docs.frappe.io/framework/user/en/installation

Creates the first bench instance. Creates a directory, navigates into it, and initializes a new bench named my-bench.

```bash
mkdir ~/frappe
cd ~/frappe
bench init my-bench
```

--------------------------------

### Add custom Jinja methods and filters via the `jinja` hook

Source: https://docs.frappe.io/framework/user/en/python-api/hooks

Configure the `jinja` hook in `app/hooks.py` to add custom methods and filters. The module path `app.jinja.methods` adds all methods in that module, while individual functions like `get_fullname` and `format_currency` are added directly. The example shows the hook configuration, the method definitions, and usage in a Jinja template.

```python
jinja = {
    "methods": [
        "app.jinja.methods",
        "app.utils.get_fullname"
    ],
    "filters": [
        "app.jinja.filters",
        "app.utils.format_currency"
    ]
}
  
```

```python
def sum(a, b):
    return a + b

def multiply(a, b):
    return a * b
  
```

```python
def get_fullname(user):
    first_name, last_name = frappe.db.get_value("User", user, ["first_name", "last_name"])
    return first_name + " " + last_name

def format_currency(value, currency):
    return currency + " " + str(value)
  
```

```html
<h1>Hi, {{ get_fullname(frappe.session.user) }}</h1>
<p>Your account balance is {{ account_balance | format_currency("INR") }}</p>
<p>1 + 2 = {{ sum(1, 2) }}</p>
  
```

--------------------------------

### Get remote app with get-app

Source: https://docs.frappe.io/framework/user/en/bench/bench-commands

Downloads a remote Frappe app from a git repository. Example uses the ERPNext repository.

```zsh
➜ bench get-app erpnext https://github.com/frappe/erpnext
```

--------------------------------

### Set required_apps hook

Source: https://docs.frappe.io/framework/user/en/python-api/hooks

Sets the required_apps hook in app/hooks.py to ensure the erpnext app is installed when someone installs your app.

```python
required_apps = ["erpnext"]
```

--------------------------------

### Access token authentication request

Source: https://docs.frappe.io/framework/user/en/api/rest

Sends a GET request to frappe.auth.get_logged_user with an Authorization header using a Bearer access_token obtained from OAuth setup.

```javascript
fetch('http://<base-url>/api/method/frappe.auth.get_logged_user', {
    headers: {
        'Authorization': 'Bearer access_token'
    }
})
```

--------------------------------

### Create a new site

Source: https://docs.frappe.io/framework/user/en/bench/reference/new-site

Creates a new site with default settings. The {site} placeholder is the site name.

```bash
bench new-site {site}
```

--------------------------------

### now() - Get current datetime

Source: https://docs.frappe.io/framework/user/en/api/utils

Returns the current datetime as a string in the format yyyy-mm-dd hh:mm:ss. The example shows the output format.

```python
from frappe.utils import now

now() # '2021-05-25 06:38:52.242515'
```

--------------------------------

### Initialize frappe-bench directory

Source: https://docs.frappe.io/framework/user/en/tutorial/install-and-setup-bench

Run this command to create a new directory named 'frappe-bench' in the current working directory. It sets up a Python virtual environment, installs the frappe app, installs node modules, and builds static assets.

```bash
$ bench init frappe-bench
```

--------------------------------

### Modify List Query with permission_query_conditions

Source: https://docs.frappe.io/framework/user/en/python-api/hooks

Configure the `permission_query_conditions` hook in `app/hooks.py` to add custom WHERE clauses for list queries. The `todo_query` function returns a SQL WHERE fragment that filters ToDo records by owner or assigned_by. The example shows the resulting query when using `frappe.db.get_list`; note that this hook only affects `frappe.db.get_list`, not `frappe.db.get_all`.

```python
permission_query_conditions = {
    "ToDo": "app.permissions.todo_query",
}
  

```

```python
def todo_query(user):
    if not user:
        user = frappe.session.user
    # todos that belong to user or assigned by user
    return "(`tabToDo`.owner = {user} or `tabToDo`.assigned_by = {user})".format(user=frappe.db.escape(user))
  

```

```python
todos = frappe.db.get_list("ToDo", debug=1)

# output
'''
select `tabToDo`.`name`
from `tabToDo`
where ((`tabToDo`.owner = 'john@doe.com' or `tabToDo`.assigned_by = 'john@doe.com'))
order by `tabToDo`.`modified` DESC
'''

```

--------------------------------

### frappe.get_last_doc: Get last document with filters

Source: https://docs.frappe.io/framework/user/en/api/document

Retrieves the last document matching the given filters. Example shows filtering by status 'Cancelled'.

```python
# get the last available Cancelled Task
task = frappe.get_last_doc('Task', filters={"status": "Cancelled"})
```

--------------------------------

### Program and args for bench serve

Source: https://docs.frappe.io/framework/user/en/debugging

The program and args in launch.json replicate the bench serve command with --noreload and --nothreading flags.

```json
"program": "${workspaceFolder}/frappe/frappe/utils/bench_helper.py",
"args": ["frappe", "serve", "--port", "8000", "--noreload", "--nothreading"]
```

--------------------------------

### Form Events - frm Parameter

Source: https://docs.frappe.io/framework/user/en/api/form

Shows that form event handlers receive frm as the first parameter, using the setup event as an example.

```javascript
frappe.ui.form.on('ToDo', {
    // frm passed as the first parameter
    setup(frm) {
        // write setup code
    }
})
  
```

--------------------------------

### Create a new site with bench new-site

Source: https://docs.frappe.io/framework/user/en/tutorial/create-a-site

Run from the frappe-bench directory to create a new site. Prompts for the MariaDB root password and then for the Administrator password; the output shows the installation progress and confirms the site is set.

```bash
$ bench new-site library.localhost
MySQL root password:

Installing frappe...
Updating DocTypes for frappe        : [========================================] 100%
Set Administrator password:
*** Scheduler is disabled ***
Current Site set to library.localhost
```

--------------------------------

### frappe.get_route() - Get current route as array

Source: https://docs.frappe.io/framework/user/en/api/js-utils

Returns the current route as an array. The example shows the output for a route like ['List', 'Task', 'List'].

```javascript
frappe.get_route()
// ["List", "Task", "List"]
```

--------------------------------

### page.get_form_values - Get all form values

Source: https://docs.frappe.io/framework/user/en/api/page

Returns an object containing all form values from the page form toolbar. The example shows a comment with the expected output format.

```javascript
let values = page.get_form_values()
// { status: 'Open', priority: 'Low' }
```

--------------------------------

### Create a new app with bench new-app

Source: https://docs.frappe.io/framework/user/en/basics/apps

Run this command from the frappe-bench directory to create a new app. It prompts for app details and installs the app, creating the app directory in the apps folder and adding it to apps.txt.

```sh
$ bench new-app custom_app
INFO:bench.app:creating new app custom_app
App Title (default: Custom App):
App Description: Custom Frappe App
App Publisher: John Doe
App Email: custom@johndoe.com
App Icon (default 'octicon octicon-file-directory'):
App Color (default 'grey'):
App License (default 'MIT'):
'custom_app' created at /Users/johndoe/frappe-bench/apps/custom_app
INFO:bench.app:installing custom_app
INFO:bench.utils:./env/bin/pip install -q -e ./apps/custom_app
```

--------------------------------

### curl request to get token

Source: https://docs.frappe.io/framework/user/en/guides/integration/rest_api/oauth-2

Example curl command to exchange the authorization code for an access token. The request includes grant_type, code, redirect_uri, and client_id as form parameters.

```bash
curl -X POST https://{your frappe instance}/api/method/frappe.integrations.oauth2.get_token \
 -H 'Content-Type: application/x-www-form-urlencoded' \
 -H 'Accept: application/json' \
 -d 'grant_type=authorization_code&code=wa1YuQMff2ZXEAu2ZBHLpJRQXcGZdr
 &redirect_uri=https%3A%2F%2Fapp.getpostman.com%2Foauth2%2Fcallback&client_id=af615c2d3a'
```

--------------------------------

### month_diff: Calculate months between two dates

Source: https://docs.frappe.io/framework/user/en/api/utils

Returns the difference between two dates in months. The example uses a fixed start date and adds 60 days, then prints the month difference, which is 2.

```python
from frappe.utils import add_to_date, month_diff
date_1 = "2024-07-01"
date_2 = add_to_date(date_1, days=60)

print(month_diff(date_2, date_1)) #2
```

--------------------------------

### GET /api/resource/Customer with filters

Source: https://docs.frappe.io/framework/user/en/guides/integration/rest_api/manipulating_documents

Retrieves a list of Customer documents filtered by phone number, returning only the 'name' field. The response shows a single customer with name CUST-00001. Authentication is required but not shown in this example.

```bash
curl -X GET https://{your frappe instance}/api/resource/Customer?fields=["name"]\
 &filters=[["Customer","phone","=","4915227058038"]]
```

```json
 {
 "data": [
 {
 "name": "CUST-00001"
 },
 ]
 }
```

--------------------------------

### Access Token JSON example with data array containing name-description pairs truncated with ellipsis GET /api/resource/:do revision  umentation REST API Frappé

Source: https://docs.frappe.io/framework/user/en/api/rest

 shows the default response format when no parameters are provided GET /api/resource/:doctype?*; includes a `data` array of objects with `name` truncated list of 8 items ending with `...` demonstrating typical output.xyz

```json; code: {
  "data":[
    {"description": 
{
  "data": 
```

--------------------------------

### CustomPage renderer class with can_render and render

Source: https://docs.frappe.io/framework/user/en/python-api/routing-and-rendering

Example custom page renderer class that extends BaseRenderer. It must implement `can_render` and `render`; `can_render` returning True makes this renderer responsible for the path. Custom renderers get priority over standard page renderers.

```python
from frappe.website.utils import build_response
from frappe.website.page_renderers.base_renderer import BaseRenderer

class CustomPage(BaseRenderer):
 def can_render(self):
 return True

 def render(self):
 response_html = "Custom Response"
 return self.build_response(response_html)

```
Tokens:
Raw