Skip to content

Latest commit

 

History

History
144 lines (109 loc) · 5.14 KB

README.rst

File metadata and controls

144 lines (109 loc) · 5.14 KB

🌊 seaport

GitHub Workflow Status Read the Docs Codecov

The modern MacPorts portfile updater.

> seaport clip gping
🌊 Starting seaport...
👍 New version is 1.2.0-post
🔻 Downloading from https://github.com/orf/gping/tarball/v1.2.0-post/gping-1.2.0-post.tar.gz
🔎 Checksums:
Old rmd160: 8b274132c8389ec560f213007368c7f521fdf682
New rmd160: 4a614e35d4e1e496871ee2b270ba8836f84650c6
Old sha256: 1879b37f811c09e43d3759ccd97d9c8b432f06c75a27025cfa09404abdeda8f5
New sha256: 1008306e8293e7c59125de02e2baa6a17bc1c10de1daba2247bfc789eaf34ff5
Old size: 853432
New size: 853450
⏪️ Changing revision numbers
No changes necessary
📋 The contents of the portfile have been copied to your clipboard!

Installation

MacPorts 🍎

sudo port install seaport

PyPi 🐍

pip3 install seaport
# Optionally, install GitHub CLI to send PRs
sudo port install gh

⚡️ Features

  • Automatically determines new version numbers and checksums for MacPorts portfiles.
  • 📋 Copies the changes to your clipboard, and optionally sends a PR to update them.
  • 🔎 Contains additional checking functionality, such as running tests, linting and installing the updated program.
  • 📚 Library for convenient access to portfile information. Easily import as a Python module for your project.
  • ⌨️ PEP 561 compatible, with built in support for type checking.
  • 📦 Works out of the box with all supported Python versions (3.7-3.11).

To find out more, please read the Documentation.

🤔 How to use seaport

For simple ports with straightforward updates, use seaport pr example_port. This sends a PR with the updated portfile and automatically fills in the PR template for you.

For ports that require some manual changes, use seaport clip example_port. This updates the version number and checksums so you don't have to. 😎

Be sure to check out the flags overview for information on additional features.

🔥 seaport vs port bump

Features 🌊 seaport 🛼 port bump
🔒 Updates checksums
📚 Updates the revision number
📝 Can write changes to the original file
⏮ Can update portfile to a specific version
🔮 Updates the version number via livecheck
🚀 Can send a pull request (both for updated and new ports)
🧪 Can lint/test/install the port to check if the update works
📋 Copies changes to clipboard
🌎 Can both manually and automatically set the url to download from

🔨 Contributing

Any change, big or small, that you think can help improve this project is more than welcome 🎉.

As well as this, feel free to open an issue with any new suggestions or bug reports. Every contribution is appreciated.

For more information, please read our contributing page on how to get started.

©️ License

Similar to other MacPorts-based projects, seaport is licensed under the BSD 3-Clause "New" or "Revised" License.

📒 Notice of Non-Affiliation and Disclaimer

This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with the MacPorts Project, or any of its subsidiaries or its affiliates. The official MacPorts Project website can be found at https://www.macports.org.

The name MacPorts as well as related names, marks, emblems and images are registered trademarks of their respective owners.