🌊 seaport
==========
|ci-badge| |rtd-badge| |cov-badge|
The modern `MacPorts <https://www.macports.org>`_ portfile updater.
.. code-block::
> 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 🍎
************
.. code-block::
sudo port install seaport
PyPi 🐍
********
.. code-block::
pip3 install seaport
# Optionally, install GitHub CLI to send PRs
sudo port install gh
⚡️ Features
--------------
🖥 `Command Line Tool <https://seaport.readthedocs.io/en/stable/overview.html>`_
*********************************************************************************
* ⏩ **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.
🐍 `Python API <https://seaport.readthedocs.io/en/stable/reference.html>`_
****************************************************************************
* 📚 Library for convenient access to portfile information. Easily import as a Python module for your project.
* ⌨️ `PEP 561 compatible <https://www.python.org/dev/peps/pep-0561>`_, with built in support for type checking.
* 📦 Works out of the box with all `supported Python versions <https://endoflife.date/python>`_ (3.7-3.11).
To find out more, please read the `Documentation <https://seaport.rtfd.io/>`_.
🤔 How to use seaport
----------------------
For simple ports with straightforward updates, use :code:`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 :code:`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 <https://seaport.readthedocs.io/en/stable/overview.html>`_ for information on additional features.
🔥 seaport vs port bump
-------------------------
.. list-table::
:widths: 25 25 25
:header-rows: 1
* - 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
---------------
- Issue Tracker: `<https://github.com/harens/seaport/issues>`_
- Source Code: `<https://github.com/harens/seaport>`_
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 <https://seaport.readthedocs.io/en/latest/contributing.html>`_ on how to get started.
©️ License
----------
Similar to other MacPorts-based projects, seaport is licensed under the `BSD 3-Clause "New" or "Revised" License <https://github.com/harens/seaport/blob/master/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.
.. |ci-badge| image:: https://img.shields.io/github/actions/workflow/status/harens/seaport/test.yml?logo=github&style=flat-square
:target: https://github.com/harens/seaport/actions
:alt: GitHub Workflow Status
.. |rtd-badge| image:: https://img.shields.io/readthedocs/seaport?logo=read%20the%20docs&style=flat-square
:target: https://seaport.rtfd.io/
:alt: Read the Docs
.. |cov-badge| image:: https://img.shields.io/codecov/c/github/harens/seaport?logo=codecov&style=flat-square
:target: https://codecov.io/gh/harens/seaport
:alt: Codecov
Raw data
{
"_id": null,
"home_page": "https://seaport.rtfd.io/",
"name": "seaport",
"maintainer": "harens",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "harensdeveloper@gmail.com",
"keywords": "MacPorts,Port,Bump,Checksums",
"author": "harens",
"author_email": "harensdeveloper@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/2b/b2/b38e44928dc92bb800ec399a842ef9335eeac83e1849b30542403dce24bf/seaport-0.10.1.tar.gz",
"platform": null,
"description": "\ud83c\udf0a seaport\n==========\n\n|ci-badge| |rtd-badge| |cov-badge|\n\nThe modern `MacPorts <https://www.macports.org>`_ portfile updater.\n\n.. code-block::\n\n > seaport clip gping\n \ud83c\udf0a Starting seaport...\n \ud83d\udc4d New version is 1.2.0-post\n \ud83d\udd3b Downloading from https://github.com/orf/gping/tarball/v1.2.0-post/gping-1.2.0-post.tar.gz\n \ud83d\udd0e Checksums:\n Old rmd160: 8b274132c8389ec560f213007368c7f521fdf682\n New rmd160: 4a614e35d4e1e496871ee2b270ba8836f84650c6\n Old sha256: 1879b37f811c09e43d3759ccd97d9c8b432f06c75a27025cfa09404abdeda8f5\n New sha256: 1008306e8293e7c59125de02e2baa6a17bc1c10de1daba2247bfc789eaf34ff5\n Old size: 853432\n New size: 853450\n \u23ea\ufe0f Changing revision numbers\n No changes necessary\n \ud83d\udccb The contents of the portfile have been copied to your clipboard!\n\nInstallation\n------------\n\nMacPorts \ud83c\udf4e\n************\n\n.. code-block::\n\n sudo port install seaport\n\nPyPi \ud83d\udc0d\n********\n\n.. code-block::\n\n pip3 install seaport\n # Optionally, install GitHub CLI to send PRs\n sudo port install gh\n\n\u26a1\ufe0f Features\n--------------\n\n\ud83d\udda5 `Command Line Tool <https://seaport.readthedocs.io/en/stable/overview.html>`_\n*********************************************************************************\n\n* \u23e9 **Automatically determines new version numbers and checksums** for MacPorts portfiles.\n* \ud83d\udccb **Copies the changes to your clipboard**, and optionally **sends a PR to update them**.\n* \ud83d\udd0e Contains **additional checking functionality**, such as running tests, linting and installing the updated program.\n\n\ud83d\udc0d `Python API <https://seaport.readthedocs.io/en/stable/reference.html>`_\n****************************************************************************\n\n* \ud83d\udcda Library for convenient access to portfile information. Easily import as a Python module for your project.\n* \u2328\ufe0f `PEP 561 compatible <https://www.python.org/dev/peps/pep-0561>`_, with built in support for type checking.\n* \ud83d\udce6 Works out of the box with all `supported Python versions <https://endoflife.date/python>`_ (3.7-3.11).\n\nTo find out more, please read the `Documentation <https://seaport.rtfd.io/>`_.\n\n\ud83e\udd14 How to use seaport\n----------------------\n\nFor simple ports with straightforward updates, use :code:`seaport pr example_port`.\nThis sends a PR with the updated portfile and automatically fills in the PR template for you.\n\nFor ports that require some manual changes, use :code:`seaport clip example_port`.\nThis updates the version number and checksums so you don't have to. \ud83d\ude0e\n\nBe sure to check out the `flags overview <https://seaport.readthedocs.io/en/stable/overview.html>`_ for information on additional features.\n\n\ud83d\udd25 seaport vs port bump\n-------------------------\n\n.. list-table::\n :widths: 25 25 25\n :header-rows: 1\n\n * - Features\n - \ud83c\udf0a seaport\n - \ud83d\udefc port bump\n * - \ud83d\udd12 Updates checksums\n - \u2705\n - \u2705\n * - \ud83d\udcda Updates the revision number\n - \u2705\n - \u2705\n * - \ud83d\udcdd Can write changes to the original file\n - \u2705\n - \u2705\n * - \u23ee Can update portfile to a specific version\n - \u2705\n - \u2705\n * - \ud83d\udd2e Updates the version number via livecheck\n - \u2705\n - \u274c\n * - \ud83d\ude80 Can send a pull request (both for updated and new ports)\n - \u2705\n - \u274c\n * - \ud83e\uddea Can lint/test/install the port to check if the update works\n - \u2705\n - \u274c\n * - \ud83d\udccb Copies changes to clipboard\n - \u2705\n - \u274c\n * - \ud83c\udf0e Can both manually and automatically set the url to download from\n - \u2705\n - \u274c\n\n\ud83d\udd28 Contributing\n---------------\n\n- Issue Tracker: `<https://github.com/harens/seaport/issues>`_\n- Source Code: `<https://github.com/harens/seaport>`_\n\nAny change, big or small, that you think can help improve this project is more than welcome \ud83c\udf89.\n\nAs well as this, feel free to open an issue with any new suggestions or bug reports. Every contribution is appreciated.\n\nFor more information, please read our `contributing page <https://seaport.readthedocs.io/en/latest/contributing.html>`_ on how to get started.\n\n\u00a9\ufe0f License\n----------\n\nSimilar to other MacPorts-based projects, seaport is licensed under the `BSD 3-Clause \"New\" or \"Revised\" License <https://github.com/harens/seaport/blob/master/LICENSE>`_.\n\n\ud83d\udcd2 Notice of Non-Affiliation and Disclaimer\n-------------------------------------------\n\nThis 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>`_.\n\nThe name MacPorts as well as related names, marks, emblems and images are registered trademarks of their respective owners.\n\n.. |ci-badge| image:: https://img.shields.io/github/actions/workflow/status/harens/seaport/test.yml?logo=github&style=flat-square\n :target: https://github.com/harens/seaport/actions\n :alt: GitHub Workflow Status\n.. |rtd-badge| image:: https://img.shields.io/readthedocs/seaport?logo=read%20the%20docs&style=flat-square\n :target: https://seaport.rtfd.io/\n :alt: Read the Docs\n.. |cov-badge| image:: https://img.shields.io/codecov/c/github/harens/seaport?logo=codecov&style=flat-square\n :target: https://codecov.io/gh/harens/seaport\n :alt: Codecov\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "The modern MacPorts portfile updater",
"version": "0.10.1",
"project_urls": {
"Bug Tracker": "https://github.com/harens/seaport/issues",
"Documentation": "https://seaport.rtfd.io/",
"Homepage": "https://seaport.rtfd.io/",
"Repository": "https://github.com/harens/seaport"
},
"split_keywords": [
"macports",
"port",
"bump",
"checksums"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8d8974b63b6199c642940eeabaadc9b7c489e0341cff78100c32a09d368aba27",
"md5": "ca89c449ee334dc61571c2a41f0b0d69",
"sha256": "40ae6c1e3496150447d0110bc452b740fed593fa365484fe84099c330e075c99"
},
"downloads": -1,
"filename": "seaport-0.10.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ca89c449ee334dc61571c2a41f0b0d69",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 41289,
"upload_time": "2023-05-21T18:23:36",
"upload_time_iso_8601": "2023-05-21T18:23:36.231509Z",
"url": "https://files.pythonhosted.org/packages/8d/89/74b63b6199c642940eeabaadc9b7c489e0341cff78100c32a09d368aba27/seaport-0.10.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2bb2b38e44928dc92bb800ec399a842ef9335eeac83e1849b30542403dce24bf",
"md5": "28e0dd2b46ae396f0e26d74f38aa8d0b",
"sha256": "ba4f9ef1ae7ecbf6341b90397481b7b3ad750b0a96855dc205e8579eff676643"
},
"downloads": -1,
"filename": "seaport-0.10.1.tar.gz",
"has_sig": false,
"md5_digest": "28e0dd2b46ae396f0e26d74f38aa8d0b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 22729,
"upload_time": "2023-05-21T18:23:37",
"upload_time_iso_8601": "2023-05-21T18:23:37.727618Z",
"url": "https://files.pythonhosted.org/packages/2b/b2/b38e44928dc92bb800ec399a842ef9335eeac83e1849b30542403dce24bf/seaport-0.10.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-21 18:23:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "harens",
"github_project": "seaport",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "seaport"
}
JSON
