From fd40585069aa554f86ef69a33fcda6567f46633b Mon Sep 17 00:00:00 2001 From: Akhil Narang Date: Wed, 18 Dec 2024 16:55:11 +0530 Subject: [PATCH] refactor: README Signed-off-by: Akhil Narang --- README.md | 125 +++++++++++++++++++++++---------------------- resources/logo.png | Bin 0 -> 1733 bytes 2 files changed, 63 insertions(+), 62 deletions(-) create mode 100644 resources/logo.png diff --git a/README.md b/README.md index c7afc665c..229838ced 100755 --- a/README.md +++ b/README.md @@ -1,52 +1,22 @@
- - - - -

Bench

-
-Bench is a command-line utility that helps you to install, update, and manage multiple sites for Frappe/ERPNext applications on [*nix systems](https://en.wikipedia.org/wiki/Unix-like) for development and production. +![Logo](resources/logo.png) + +## Bench +**CLI to manage Frappe/ERPNext applications** + + +[![Python version](https://img.shields.io/badge/python-%3E=_3.10-green.svg)](https://www.python.org/downloads/) +[![PyPI Version](https://badge.fury.io/py/frappe-bench.svg)](https://pypi.org/project/frappe-bench) +![Platform Compatibility](https://img.shields.io/badge/platform-linux%20%7C%20osx-blue) +[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Ffrappe%2Fbench.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Ffrappe%2Fbench?ref=badge_shield) +[![License: GPLv3](https://img.shields.io/badge/License-GPLv3-blue.svg)](#LICENSE) -
- - - - - - - - PyPI version - - - - - - - - - -
-## Table of Contents - -- [Table of Contents](#table-of-contents) -- [Installation](#installation) - - [Containerized Installation](#containerized-installation) - - [Easy Install Script](#easy-install-script) - - [Setup](#setup) - - [Arguments](#arguments) - - [Troubleshooting](#troubleshooting) - - [Manual Installation](#manual-installation) -- [Basic Usage](#basic-usage) -- [Custom Bench Commands](#custom-bench-commands) -- [Guides](#guides) -- [Resources](#resources) -- [Development](#development) -- [Releases](#releases) -- [License](#license) +## Bench +Bench is a command-line utility that helps you to install, update, and manage multiple sites for Frappe/ERPNext applications on [*nix systems](https://en.wikipedia.org/wiki/Unix-like) for development and production. ## Installation @@ -59,8 +29,16 @@ The setup for each of these installations can be achieved in multiple ways: We recommend using Docker Installation to setup a Production Environment. For Development, you may choose either of the two methods to setup an instance. -Otherwise, if you are looking to evaluate Frappe apps without hassle of hosting, you can try them [on frappecloud.com](https://frappecloud.com/). +Otherwise, if you are looking to evaluate Frappe apps without the hassle of managing hosting yourself, you can try them on [Frappe Cloud](https://frappecloud.com/). +
+ + + + Try on Frappe Cloud + + +
### Containerized Installation @@ -69,8 +47,7 @@ A Frappe/ERPNext instance can be setup and replicated easily using [Docker](http To setup either of the environments, you will need to clone the official docker repository: ```sh -$ git clone https://github.com/frappe/frappe_docker.git -$ cd frappe_docker +git clone https://github.com/frappe/frappe_docker.git ``` A quick setup guide for both the environments can be found below. For more details, check out the [Frappe/ERPNext Docker Repository](https://github.com/frappe/frappe_docker). @@ -86,8 +63,8 @@ This script uses Docker with the [Frappe/ERPNext Docker Repository](https://gith Download the Easy Install script and execute it: ```sh -$ wget https://raw.githubusercontent.com/frappe/bench/develop/easy-install.py -$ python3 easy-install.py deploy --email=user@domain.tld --sitename=subdomain.domain.tld --app=erpnext +wget https://raw.githubusercontent.com/frappe/bench/develop/easy-install.py +python3 easy-install.py deploy --email=user@domain.tld --sitename=subdomain.domain.tld --app=erpnext ``` This script will install docker on your system and will fetch the required containers, setup bench and a default ERPNext instance. @@ -255,11 +232,11 @@ In case the setup fails, the log file is saved under `$HOME/easy-install.log`. Y Some might want to manually setup a bench instance locally for development. To quickly get started on installing bench the hard way, you can follow the guide on [Installing Bench and the Frappe Framework](https://frappe.io/docs/user/en/installation). -You'll have to set up the system dependencies required for setting up a Frappe Environment. Checkout [docs/installation](https://github.com/frappe/bench/blob/develop/docs/installation.md) for more information on this. If you've already set up, install bench via pip: +You'll have to set up the system dependencies required for setting up a Frappe Environment. Checkout [docs/installation](https://docs.frappe.io/framework/user/en/tutorial/install-and-setup-bench) for more information on this. If you've already set up, install bench via pip: ```sh -$ pip install frappe-bench +pip install frappe-bench ``` @@ -348,27 +325,32 @@ To contribute and develop on the bench CLI tool, clone this repo and create an e This is not the recommended mode of installation for production. Instead, install the package from PyPI with: `pip install frappe-bench` +### Clone and install ```sh -$ git clone https://github.com/frappe/bench ~/bench-repo -$ pip3 install -e ~/bench-repo -$ bench src -/Users/frappe/bench-repo +git clone https://github.com/frappe/bench ~/bench-repo +pip install -e ~/bench-repo ``` -To clear up the editable install and switch to a stable version of bench, uninstall via pip and delete the corresponding egg file from the python path. +```shell +bench src +``` +This should display $HOME/bench-repo +### To clear up the editable install and delete the corresponding egg file from the python path: ```sh # Delete bench installed in editable install -$ rm -r $(find ~ -name '*.egg-info') -$ pip3 uninstall frappe-bench +rm -r $(find ~ -name '*.egg-info') +pip uninstall frappe-bench +``` -# Install latest released version of bench -$ pip3 install -U frappe-bench +### Then you can install the latest from PyPI +```sh +pip install -U frappe-bench ``` -To confirm the switch, check the output of `bench src`. It should change from something like `$HOME/bench-repo` to `/usr/local/lib/python3.6/dist-packages` and stop the editable install warnings from getting triggered at every command. +To confirm the switch, check the output of `bench src`. It should change from something like `$HOME/bench-repo` to `/usr/local/lib/python3.12/dist-packages` and stop the editable install warnings from getting triggered at every command. ## Releases @@ -391,6 +373,25 @@ The intermediate `staging` branch exists to mediate the `bench.VERSION` conflict > Note: We may want to kill the convention of separate branches for different version releases of Bench. We don't need to maintain this the way we do for Frappe & ERPNext. A single branch named `stable` would sustain. -## License +## Learn and connect -This repository has been released under the [GNU GPLv3 License](LICENSE). +- [Discuss](https://discuss.frappe.io/) +- [YouTube](https://www.youtube.com/@frappetech) + +## Contribute +To contribute to this project, please review the [Contribution Guidelines](https://github.com/frappe/erpnext/wiki/Contribution-Guidelines) for detailed instructions. Make sure to follow our [Code of Conduct](https://github.com/frappe/frappe/blob/develop/CODE_OF_CONDUCT.md) to keep the community welcoming and respectful. + +## Security +The Frappe team and community prioritize security. If you discover a security issue, please report it via our [Security Report Form](https://frappe.io/security). +Your responsible disclosure helps keep Frappe and its users safe. We'll do our best to respond quickly and keep you informed throughout the process. +For guidelines on reporting, check out our [Reporting Guidelines](https://frappe.io/security), and review our [Logo and Trademark Policy](https://github.com/frappe/erpnext/blob/develop/TRADEMARK_POLICY.md) for branding information. + +

+
+ + + + Frappe Technologies + + +
diff --git a/resources/logo.png b/resources/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..d8bd35abcc2d3de522faa5a5cd7eb746166d0132 GIT binary patch literal 1733 zcmZ9Mc{JOJ7RP_a5<+OuL~40P#2)$K7a`O%nv~R1)KW{Wl?q}@232hdRf)FtsVb`R zikem#s_jrzQ0<5^%1|B4Xhq-fUZPa1UOSmH=e%>~{c-R2-tWDibN{L*j5KSNnTmW_4DCNeRMarg5AfGk;^lMetpGAm~l0KNqQ;9rpdK&}D+bV|*S zzRt42SJ57BRN%{n;?X`?r;_3x%mx4y?$3~;`x#4QCX7S(qQO?xG*$KOiS+EEsL_sa9b7CY!Z8xAGb$As!Mr$p%?OPkuN4?ABsu_(2s<#!P z2BsTaJmgfA9G{qHRka)OPi<>My!(#s*fd^0s@rkU#v8OPjvHOdE#zsujsCUlW7jdR z+YCiD?;@qbR|}lm4qr6W&;Kg#+EL7%L`F`iiJ)|-D78W?zd2?>k-xLqVnf%)!pBEo zJw2Wh wN6p7}bz-P=!uhA;5(OJa+O-GvIa&?lCD%EkN&m2brOY&!)7t}N1Ev52Q zc*HW`Ref@{(FB`ZxHQ$&F|BvC_ zs&^2xmm;5%19z0JFv^$=pCJ%&ZSeqd1<|$hT3{%YFL*EjY!?~6JVYpqkIznEJZ?y= zuMO{wo@qy2kQ}~|E$^RGUtJ4H9nti;I?U=mL5_*Kv{UGqOGv}S&mO5|g*pQ8h={;J zMtJ9=Q=RL1eAw=Kc>?$F0P6WOp42V_epy^{97*?n_lS_m-=jP8bXc!Ma5*ap&6${f z3^mkQruQ-4v&%DXiGFNuj;!@cW>+zKtS0y%^4||XUy9C;`e}TRzov!5Y#e5Y4-a1g zw+vQ9!Hp<~fDgYxuV9uIGj68H0X=b-2YN3iNL;yA&)c@BRF396OrKz#G()DSC*$BH z&cd&cAdZLO?As}@TK|<2V;jl%_)x$Pd0MLEZsW$Op)xr_Dp%^kWr4(ULIEPqlCrEl3~VA(y&mY>$#f ztNl2rz3ccH+TObzri2Q#v4aq8KUwa?Oq1;-tW95TdP>nszN?WLq6bMgNv*fa^fxE> z<8!`W-4yLNd&onCM{6J#B!`toC8inp>xwG96NOD*N3Jh9Gz9Bu{ipMgGvW*=j9uL0 zE0H@gc}5yrUqq~vyeiOWJ$SY$es7Tb(I>?Que7Y6bAW93pSeCsyjHZOFd*ydRvYQ) z)j6_lWta2?$_E_MHrnn`*1xz>EG(eC+$z+%y%=1LcW0VZ;Xj;)^{adqOl^qR{*wm> zaQWqG`wD|U3s9cc%ADhXYuUmqBN(e@Khg3wDJbNnQe;)A{jb9IfU|GX=TDwL5Pz!l z{(H{}QQy3r;&P3&&HUrJo2yHF)kN-$DVZ|BzC5h~t&gV?dg*uV4TzuNr= zThsVaFjea5(yYC)i4217ErF-*KMjRY#s^-+gWqRdX>wj80nnr?!jiRJ_Q<{TwZXZR zywsm*&$QOfNf_=*z->eB4aJlK1!h>H!bw-pw%*KA2F1?V3X{}J4MLL*q6a-(=QW#1 zX2Zs3JVKk?w&>Qu-0$8rDx}g$@)Y(=d`VH+*|F~3$&X^+Og-ZYHDbw3jY_i{OzY3$j(8#wuI!6R4c*XkGU^nG;8mLHc*bx7M zP(-z()nFNQ86>5Pnu-r-gnN)eU80lleh=xw6%qBh(dE=!`o3dYRmGU3jrOeTXCH^P z^t_3Z?;qVWdjux(Z|l_1HO4GDn?7tT)4V5%l2Ke)Y1M!jOoB#j- literal 0 HcmV?d00001