debutils


Namedebutils JSON
Version 0.2.2 PyPI version JSON
download
home_page
SummaryUtilities to help Debian package maintainers.
upload_time2024-01-02 07:49:47
maintainer
docs_urlNone
author
requires_python>=3.8
license
keywords debian
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # debutils

[![PyPI - Version](https://img.shields.io/pypi/v/debutils.svg)](https://pypi.org/project/debutils)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/debutils.svg)](https://pypi.org/project/debutils)

Utilities to help Debian package maintainers.

This tool is currently very unstable. Feel free to use it, but please report
any bugs you find. If you have an idea for a new feature or commands, then
please let me know! [More info](#opening-issues)

-----

**Table of Contents**

- [Installation](#installation)
- [Contributing](#contributing)
  - [Opening issues](#opening-issues)
  - [Pull requests](#pull-requests)
- [Developing](#developing)
- [Why](#why)
- [Acknowledgements](#acknowledgements)
- [Packaging for Debian](#packaging-for-debian)
- [License](#license)

## Installation

To install from git:
```console
pip install git+https://codeberg.org/Maytha8/debutils.git
# I recommend using pipx instead of pip
```

To install from pypi:
```console
pip install debutils
# I recommend using pipx instead of pip
```

## Contributing

There are several ways you can contribute to debutils.

### Opening issues

If you find any bugs, or have any ideas for new functionality, please don't
hesitate to [open an issue](https://codeberg.org/Maytha8/debutils/issues/new).

### Pull requests

There's a long list of TODOs. Some of them can be found in [TODO](./TODO), and
others are strewn throughout the code as TODO comments.

You can help out by taking on one of these tasks and opening a pull request
with your changes.

## Developing

Clone this repo, and either use `hatch run ./main.py` or `hatch shell &&
./main.py` to run the CLI. (using `hatch run debutils` will install debutils
inside the venv, changes to the code aren't applied)

## Why

I had a few useful scripts lying around, so I decided to put them together and
create debutils. (e.g. [itpwriter](https://codeberg.org/Maytha8/itpwriter) is
now part of debutils.)

Additionally, dh-make-golang's make command failed to work some of the time,
leading to me having to manually follow dh-make-golang's source code and
assemble a package myself, and the estimate command *always* failed when I
tried it, even when I installed straight from the repo's HEAD.

## Acknowledgements

- [dh-make-golang](https://github.com/Debian/dh-make-golang) - the `go`
  subcommands are partially based on the work at dh-make-golang

## Packaging for Debian

I haven't packaged this for Debian (yet) because there isn't enough interest.
AFAIK I'm the only one using this.

If you reckon my work is worth having a package in Debian, feel free to file an
RFP at the Debian BTS (and X-Debbugs-CC me), or even better, package this
yourself (please add me to uploaders and let me know if you do so).

## License

```txt
debutils -- Utilities to help Debian package maintainers.
Copyright (C) 2023 Maytham Alsudany <maytha8thedev@gmail.com>

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.
```

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "debutils",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "debian",
    "author": "",
    "author_email": "Maytham Alsudany <maytha8thedev@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/9c/c0/425c4671352397f2dce1d73f90743d861b25f91613a6d6ad97087c86a2ed/debutils-0.2.2.tar.gz",
    "platform": null,
    "description": "# debutils\n\n[![PyPI - Version](https://img.shields.io/pypi/v/debutils.svg)](https://pypi.org/project/debutils)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/debutils.svg)](https://pypi.org/project/debutils)\n\nUtilities to help Debian package maintainers.\n\nThis tool is currently very unstable. Feel free to use it, but please report\nany bugs you find. If you have an idea for a new feature or commands, then\nplease let me know! [More info](#opening-issues)\n\n-----\n\n**Table of Contents**\n\n- [Installation](#installation)\n- [Contributing](#contributing)\n  - [Opening issues](#opening-issues)\n  - [Pull requests](#pull-requests)\n- [Developing](#developing)\n- [Why](#why)\n- [Acknowledgements](#acknowledgements)\n- [Packaging for Debian](#packaging-for-debian)\n- [License](#license)\n\n## Installation\n\nTo install from git:\n```console\npip install git+https://codeberg.org/Maytha8/debutils.git\n# I recommend using pipx instead of pip\n```\n\nTo install from pypi:\n```console\npip install debutils\n# I recommend using pipx instead of pip\n```\n\n## Contributing\n\nThere are several ways you can contribute to debutils.\n\n### Opening issues\n\nIf you find any bugs, or have any ideas for new functionality, please don't\nhesitate to [open an issue](https://codeberg.org/Maytha8/debutils/issues/new).\n\n### Pull requests\n\nThere's a long list of TODOs. Some of them can be found in [TODO](./TODO), and\nothers are strewn throughout the code as TODO comments.\n\nYou can help out by taking on one of these tasks and opening a pull request\nwith your changes.\n\n## Developing\n\nClone this repo, and either use `hatch run ./main.py` or `hatch shell &&\n./main.py` to run the CLI. (using `hatch run debutils` will install debutils\ninside the venv, changes to the code aren't applied)\n\n## Why\n\nI had a few useful scripts lying around, so I decided to put them together and\ncreate debutils. (e.g. [itpwriter](https://codeberg.org/Maytha8/itpwriter) is\nnow part of debutils.)\n\nAdditionally, dh-make-golang's make command failed to work some of the time,\nleading to me having to manually follow dh-make-golang's source code and\nassemble a package myself, and the estimate command *always* failed when I\ntried it, even when I installed straight from the repo's HEAD.\n\n## Acknowledgements\n\n- [dh-make-golang](https://github.com/Debian/dh-make-golang) - the `go`\n  subcommands are partially based on the work at dh-make-golang\n\n## Packaging for Debian\n\nI haven't packaged this for Debian (yet) because there isn't enough interest.\nAFAIK I'm the only one using this.\n\nIf you reckon my work is worth having a package in Debian, feel free to file an\nRFP at the Debian BTS (and X-Debbugs-CC me), or even better, package this\nyourself (please add me to uploaders and let me know if you do so).\n\n## License\n\n```txt\ndebutils -- Utilities to help Debian package maintainers.\nCopyright (C) 2023 Maytham Alsudany <maytha8thedev@gmail.com>\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with this program.  If not, see <https://www.gnu.org/licenses/>.\n```\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Utilities to help Debian package maintainers.",
    "version": "0.2.2",
    "project_urls": {
        "Documentation": "https://codeberg.org/Maytha8/debutils#readme",
        "Issues": "https://codeberg.org/Maytha8/debutils/issues",
        "Source": "https://codeberg.org/Maytha8/debutils"
    },
    "split_keywords": [
        "debian"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2350c3d588fd07b09a38b5864fc42544545bfb94f4e3aa7b32f84c3b870f9eea",
                "md5": "77b2a0ae3d8afbd27611fe1768bf5d5e",
                "sha256": "443b25a5421273ee96d95eff1d77b92c4a19417c0b204ab68de34b4c940e84c5"
            },
            "downloads": -1,
            "filename": "debutils-0.2.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "77b2a0ae3d8afbd27611fe1768bf5d5e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 64390,
            "upload_time": "2024-01-02T07:49:44",
            "upload_time_iso_8601": "2024-01-02T07:49:44.925570Z",
            "url": "https://files.pythonhosted.org/packages/23/50/c3d588fd07b09a38b5864fc42544545bfb94f4e3aa7b32f84c3b870f9eea/debutils-0.2.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9cc0425c4671352397f2dce1d73f90743d861b25f91613a6d6ad97087c86a2ed",
                "md5": "a7a079ce03b1fd09a4806cd479b70a1a",
                "sha256": "c22a8ab611dc294dcdadc714bb59e7a3fa224cfd65e75543153862e57112a908"
            },
            "downloads": -1,
            "filename": "debutils-0.2.2.tar.gz",
            "has_sig": false,
            "md5_digest": "a7a079ce03b1fd09a4806cd479b70a1a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 43919,
            "upload_time": "2024-01-02T07:49:47",
            "upload_time_iso_8601": "2024-01-02T07:49:47.198670Z",
            "url": "https://files.pythonhosted.org/packages/9c/c0/425c4671352397f2dce1d73f90743d861b25f91613a6d6ad97087c86a2ed/debutils-0.2.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-02 07:49:47",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": true,
    "codeberg_user": "Maytha8",
    "codeberg_project": "debutils#readme",
    "lcname": "debutils"
}
        
Elapsed time: 3.07239s