Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Do not expose bun CLI to the end user #3

Merged
merged 2 commits into from
Oct 8, 2024
Merged

Do not expose bun CLI to the end user #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
53a9711
fix!(distrib): Do not expose `bun` CLI to the end user
ducdetronquito Oct 7, 2024
fe75d57
doc: Ease intro readability
ducdetronquito Oct 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,26 @@


[Bun](https://bun.sh/) is an all-in-one toolkit for JavaScript and TypeScript apps.
The [pybun](https://pypi.org/project/pybun/) Python package redistributes the Bun CLI executable so that it can be used as a dependency in your Python projects.

The [pybun](https://pypi.org/project/pybun/) Python package redistributes the Bun executable so that it can be used as a dependency in your Python projects.


Usage
-----

To run the Bun CLI from the command line, you can use:
### Command line

```shell
pybun --version
bun --version
```

### Run library module as a script

```shell
python -m pybun --version
```

To run the Bun CLI from a Python program, use `sys.executable` to locate the Python binary to invoke. For example:
### From python

```python
import sys, subprocess
Expand Down
1 change: 0 additions & 1 deletion assets/entry_points.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
[console_scripts]
bun = pybun.__main__:main
pybun = pybun.__main__:main