# `install_binaries` - install executable programs in bin/
`install_binaries` is a tool to help you create wrappers around
executable files. It ensures that they're installed in a reasonable
directory, and that they have their +x bit set. It should work fine
with old versions of pip and setuptools, and with Python 2.7 and up.
It should work with both `sdist` and `bdist_wheel` packages.
To use it, you have to do two things. First, you need to add two lines
to your `setup.py`:
```
setup(
name="my_cool_app",
...
setup_requires=['install_binaries'],
install_binaries=['my-binary', 'build/other-one'],
)
```
This will install both `my-binary` and `other-one` to
`.../my-virtualenv/bin` when your package is installed.
Second, you need to make sure your binary is included in your
`MANIFEST.in` file. So that might look like:
```
include requirements.txt
include VERSION
include my-binary
include build/other-one
```
If it's left out, it won't be included in the package that `python
setup.py sdist` creates.
## Known limitations
If your package gets installed as an egg, by using `easy_install` or
`setup.py install`, the `install_binaries` code never gets called, so we
have no chance to install the binaries. There may be a way around this,
but I haven't found it. `install_binaries` attempts to warn the user in
this situation.
`install_binaries` is a tool to help you create wrappers around
executable files. It ensures that they're installed in a reasonable
directory, and that they have their +x bit set. It should work fine
with old versions of pip and setuptools, and with Python 2.7 and up.
It should work with both `sdist` and `bdist_wheel` packages.
To use it, you have to do two things. First, you need to add two lines
to your `setup.py`:
```
setup(
name="my_cool_app",
...
setup_requires=['install_binaries'],
install_binaries=['my-binary', 'build/other-one'],
)
```
This will install both `my-binary` and `other-one` to
`.../my-virtualenv/bin` when your package is installed.
Second, you need to make sure your binary is included in your
`MANIFEST.in` file. So that might look like:
```
include requirements.txt
include VERSION
include my-binary
include build/other-one
```
If it's left out, it won't be included in the package that `python
setup.py sdist` creates.
## Known limitations
If your package gets installed as an egg, by using `easy_install` or
`setup.py install`, the `install_binaries` code never gets called, so we
have no chance to install the binaries. There may be a way around this,
but I haven't found it. `install_binaries` attempts to warn the user in
this situation.
Metadata
Release files for install_binaries 0.4.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| install_binaries-0.4.1.tar.gz | 3.7 kB | Details |
Release files / install_binaries-0.4.1.tar.gz
| Download URL | install_binaries-0.4.1.tar.gz |
|---|---|
| Size | 3.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5c2e58b554fe33c253f85bb4e7564b063f478bbc5f22116a69149faa31a84a6f
|
|
BLAKE2b-256 checksum How to use checksums |
db5c391a40d92d335f05f2a3200ccdd60c1fab24724ef9b4ad8cfedb5388f2f9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |