Skip to content

Commit

Permalink
Merge pull request #3 from ducdetronquito/task/do-not-expose-bun-cli-…
Browse files Browse the repository at this point in the history
…to-an-end-user-silently

Do not expose `bun` CLI to the end user
  • Loading branch information
ducdetronquito authored Oct 8, 2024
2 parents 9296905 + fe75d57 commit d21e0bc
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
13 changes: 9 additions & 4 deletions README.md
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
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
[console_scripts]
bun = pybun.__main__:main
pybun = pybun.__main__:main

0 comments on commit d21e0bc

Please sign in to comment.