sailboat
About
Sailboat is a Python developer's best friend. It's a Python build tool that can do anything you need it to! It suports a countless number of plugins — you can even make your own. Sailboat is made for anyone, whether you are a beginner on your very first project, or a senior software engineer with years of experience.
Let's say that that you have created a basic game, Guess My Number, and you want to send it to all of your friends. There are a lot of different ways you can do this, but using Sailboat is the easiest. All you have to do is type three commands: sail quickstart, sail build, and sail release, and you can have a Homebrew file, a pip installable package, and a PyInstaller desktop app. So easy!
Sailboat also supports custom subcommands. These don't build your project, but they can add features such as a todo list that help speed up your development process.
Installation
Pip:
pip3 install sailboat
Binary:
Download from latest release.
Homebrew:
brew install cole-wilson/taps/Sailboat
Build From Source:
git clone https://github.com/cole-wilson/sailboat
cd sailboat
python3 setup.py install
Usage:
Sailboat is intended to be used from the command line/terminal.
It is suggested to run sail quickstart to get started. Then, use sail build to build your project, and sail release to release it! Be sure to to look at the subcommand docs for more detail.
(look in table below)
There are two base commands that can be used: sail and sailboat. These both do exactly the same thing, there is no difference. sail will be used in the documentation, as it's shorter easier to type, but you can do whatever.
To get a list of the availible subcommands type sail help.
To refresh the plugin list, type sail -r.
There are countless subcommands, but these are the core ones:
| subcommand | description |
|---|---|
| add | Add a plugin to your project. |
| build | Build your project for release. |
| dev | Run your project without building it. |
| git | Manage git for your project. |
| github | Manage git for your project. |
| plugins | Plugin manager. |
| quickstart | Get your project up and running. |
| release | Release your project. |
| remove | Remove a plugin from you project. |
| wizard | Configure you project or a plugin. |
| workflow | Generate a GitHub actions workflow file. |
| help | Display this message. |
Plugins:
Sailboat uses a plugin based architecture. Every single command or subcommand is a plugin, even the core features. Plugins are registered using the Python entry points system, using the group name sailboat_plugins. There are four types of plugins:
core
This type of plugin is reserved for 1st party plugins - plugins that are part of the actual Sailboat source. They have unreserved access to all project data, and therefore this type should not be used in custom plugins.
command
command plugins are most basic form of a plugin. They are called by typing sail <name of plugin>. They are standalone python scripts that add to the project, like a task list manager.
build
This is perhaps the most common type of plugin, they are run with the build core plugin, and are used to generate or edit project files. An example would be the PyInstaller plugin, which generates frozen binaries of the project. These should store output in the top level dist folder, in a subfolder with the name of the project. For example: the PyInstaller plugin saves output in ./dist/pyinstaller. Build plugins can also contain release plugins within them.
release
This group of plugins is used by the release core plugin. They are used to distribute files. For example: the homebrew release plugin uploads the Homebrew formula to a GitHub repo.
All plugins should be a subclass of sailboat.plugins.Plugin, a basic class that provide the neccesary functions and registration features. An example command plugin might look like this:
from sailboat.plugins import Plugin
class Echo(Plugin):
description = "A basic command plugin that echos it's input."
_type = 'command'
setup = {"string_to_echo":"What string should I echo? "} # Used by wizard
def run(self):
string = self.getData('string_to_echo') # Get string to echo.
print(string)
return
Plugins store their data in the sailboat.toml file, under their type namespace. For example, the above example will store it's data like so:
...
[command.echo]
string_to_echo = "Testing..."
...
A plugin should NEVER edit the sailboat.toml file on it's own. Instead plugins should use the provided functions OR edit self.data, a dictionary of the file. Only data stored in the plugins namespace will be preserved. However, a plugin can read from the top level data.
Plugins can get very complex, and therefore useful, but it is too long to put here. Please look at the sailboat.colewilson.xyz/plugins.html file for details.
Acknowledgements:
Thanks to all the people at PyInstaller, dmgbuild, twine, and GitHub actions who provided ways for me to create this.
Stargazers
Contributors
- Cole Wilson
Contact
Please submit an issue if you have any questions or need help or find a bug. I'm happy to help!
1 maintainer
Metadata
1 maintainer
Release files for sailboat 0.26.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| sailboat-0.26.2.tar.gz | 33.8 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sailboat-0.26.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 70.1 kB
Release files / sailboat-0.26.2.tar.gz
| Download URL | sailboat-0.26.2.tar.gz |
|---|---|
| Size | 33.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c4673fedfbb3d526599fb602988c82f67c8357cb821e686fd7906831b175637f
|
|
BLAKE2b-256 checksum How to use checksums |
3aae08650d566196de2d8c80ba7657692d8ba77bc27665ea98d34f48a2e26675
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/3.10.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.8.0 tqdm/4.60.0 CPython/3.8.9
|
Release files / sailboat-0.26.2-py3-none-any.whl
| Download URL | sailboat-0.26.2-py3-none-any.whl |
|---|---|
| Size | 36.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2b2c73753ff00890c390ee1f8091b67577f993dccfc3cf668be6f2d690d25b49
|
|
BLAKE2b-256 checksum How to use checksums |
2d801319957ea91e73f4d5d7a48da1b5072e256cbf3bd425bd8076c089fdaf4b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/3.10.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.8.0 tqdm/4.60.0 CPython/3.8.9
|
Security for sailboat 0.26.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
