Welcome to box
The goal of this package is
to provide a command line interface
that allows you to easily package your existing python project
with PyApp
.
Currently, box
only support python projects that have their metadata stored in a pyproject.toml
file.
See here
for details.
Warning
- This package is still in a very early development phase! Please report your findings and issues, so that we can improve this tool together.
box
is not yet production ready and breaking changes may occur with new releases. These will be noted in the release notes and in the changelog.
Issues, comments, contributions,...
We welcome contributions to this project. If you run into any problem, want to suggest a feature, want to contribute, or just want to say hi, please feel free to open an issue on GitHub or to start a new discussion.
Pre-requisites
In order to run box
, you must have cargo
installed.
Instructions to do so can be found
here.
Installation
Installation Instructions
To install with pipx
, type:
Alternatively, you can install the latest version directly from the GitHub repo. This is only recommended if you want the latest tweaks. For a production environment, please use the official releases.
To install box as a rye
tool, type:
Alternatively, you can install the latest version directly from the GitHub repo. This is only recommended if you want the latest tweaks. For a production environment, please use the official releases.
We do not recommend installing box
with pip
,
however, if have to do so for some reason,
install it via:
Alternatively, you can install the latest version directly from the GitHub repo. This is only recommended if you want the latest tweaks. For a production environment, please use the official releases.
Usage - the short version
Initialize a project
From within your project directory, run:
This will ask you a few questions, answer them, and you will be done.
Packaging
To package your project, run:
This will first build your project using. the selected builder.
Then, the latest PyApp
source will be downloaded and unpacked.
Finally, the project will be packaged with PyApp
using cargo
.
You can find the executable in the target/release
directory.