| Name | mozilla-linux-pkg-manager JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | |
| Summary | `mozilla-releng/mozilla-linux-pkg-manager` is a Python tool for managing Mozilla `.deb` packages. |
| upload_time | 2023-11-16 21:53:31 |
| maintainer | |
| docs_url | None |
| author | Mozilla Release Engineering |
| requires_python | >=3.11,<4.0 |
| license | MPL-2.0 |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://firefox-ci-tc.services.mozilla.com/api/github/v1/repository/mozilla-releng/mozilla-linux-pkg-manager/main/latest)
[](https://results.pre-commit.ci/latest/github/mozilla-releng/mozilla-linux-pkg-manager/main)
[](https://codecov.io/gh/mozilla-releng/mozilla-linux-pkg-manager)
[](https://mozilla-linux-pkg-manager.readthedocs.io/en/latest/?badge=latest)
[](http://mozilla.org/MPL/2.0)
# mozilla-linux-pkg-manager
`mozilla-releng/mozilla-linux-pkg-manager` is a Python tool for managing Mozilla product packages hosted in Linux software repositories.
It can be used to clean-up obsolete Firefox Nightly versions.
## Requirements
- Python 3.11 or higher
- Poetry (for dependency management)
## Installation
1. **Install Poetry**: If not already installed, install Poetry by following the instructions from the [official Poetry website](https://python-poetry.org/docs/).
2. **Clone the Repository**: Clone the `mozilla-linux-pkg-manager` repository using the command `git clone https://github.com/mozilla-releng/mozilla-linux-pkg-manager.git`.
3. **Install Dependencies**: Navigate to the repository's root directory and run `poetry install` to install the required dependencies.
### Running `mozilla-linux-pkg-manager`
To run `mozilla-linux-pkg-manager`, use Poetry with the following command:
```bash
poetry run mozilla-linux-pkg-manager clean-up --product [PRODUCT] --channel [CHANNEL] --retention-days [DAYS]
```
### Parameters
- `--product`: Specifies the Mozilla product to manage (e.g. `nightly`, `release`, `beta`). Currently, only `firefox` is supported.
- `--channel`: Specifies the package channel (e.g. `nightly`, `release`, `beta`). Currently, only `nightly` is supported.
- `--retention-days`: Sets the retention period in days for packages in the nightly channel. This parameter is only supported on the `nightly` channel.
### Example
To clean up nightly packages that are older than 7 days:
```bash
poetry run mozilla-linux-pkg-manager clean-up --product firefox --channel nightly --retention-days 7
```
## Building and Installing a Python Wheel
The `mozilla-linux-pkg-manager` package can be packaged into a wheel file for distribution and installation.
### Building the Wheel
1. **Navigate to the Project Directory**: Open your terminal and navigate to the directory where your project is located.
2. **Build the Package**: Execute `poetry build` to create the wheel file. This will generate a `dist` folder in your project directory containing the `.whl` file, whose name may vary based on the version and build.
### Installing the Wheel File
1. **Navigate to the `dist` Directory**: Move to the `dist` directory where the `.whl` file is located.
2. **Install the Wheel File**: Use `pip install [wheel-file-name]` to install the package. Replace `[wheel-file-name]` with the actual name of the wheel file generated during the build process.
### Using the Installed Package
After installation, the package can be used from anywhere on your system, provided you are running the Python interpreter where it was installed. For example:
```bash
mozilla-linux-pkg-manager clean-up --product firefox --channel nightly --retention-days 3
```
Raw data
{
"_id": null,
"home_page": "",
"name": "mozilla-linux-pkg-manager",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Mozilla Release Engineering",
"author_email": "release@mozilla.com",
"download_url": "https://files.pythonhosted.org/packages/a6/a0/0fb7f71a39758a01439d5e1f87ec6f366f63b8bb2955f69b57d853f4562a/mozilla_linux_pkg_manager-0.1.0.tar.gz",
"platform": null,
"description": "[](https://firefox-ci-tc.services.mozilla.com/api/github/v1/repository/mozilla-releng/mozilla-linux-pkg-manager/main/latest)\n[](https://results.pre-commit.ci/latest/github/mozilla-releng/mozilla-linux-pkg-manager/main)\n[](https://codecov.io/gh/mozilla-releng/mozilla-linux-pkg-manager)\n[](https://mozilla-linux-pkg-manager.readthedocs.io/en/latest/?badge=latest)\n[](http://mozilla.org/MPL/2.0)\n\n# mozilla-linux-pkg-manager\n\n`mozilla-releng/mozilla-linux-pkg-manager` is a Python tool for managing Mozilla product packages hosted in Linux software repositories.\nIt can be used to clean-up obsolete Firefox Nightly versions.\n\n## Requirements\n- Python 3.11 or higher\n- Poetry (for dependency management)\n\n## Installation\n1. **Install Poetry**: If not already installed, install Poetry by following the instructions from the [official Poetry website](https://python-poetry.org/docs/).\n2. **Clone the Repository**: Clone the `mozilla-linux-pkg-manager` repository using the command `git clone https://github.com/mozilla-releng/mozilla-linux-pkg-manager.git`.\n3. **Install Dependencies**: Navigate to the repository's root directory and run `poetry install` to install the required dependencies.\n\n### Running `mozilla-linux-pkg-manager`\nTo run `mozilla-linux-pkg-manager`, use Poetry with the following command:\n```bash\npoetry run mozilla-linux-pkg-manager clean-up --product [PRODUCT] --channel [CHANNEL] --retention-days [DAYS]\n```\n\n### Parameters\n- `--product`: Specifies the Mozilla product to manage (e.g. `nightly`, `release`, `beta`). Currently, only `firefox` is supported.\n- `--channel`: Specifies the package channel (e.g. `nightly`, `release`, `beta`). Currently, only `nightly` is supported.\n- `--retention-days`: Sets the retention period in days for packages in the nightly channel. This parameter is only supported on the `nightly` channel.\n\n### Example\nTo clean up nightly packages that are older than 7 days:\n\n```bash\npoetry run mozilla-linux-pkg-manager clean-up --product firefox --channel nightly --retention-days 7\n```\n\n## Building and Installing a Python Wheel\n\nThe `mozilla-linux-pkg-manager` package can be packaged into a wheel file for distribution and installation.\n\n### Building the Wheel\n1. **Navigate to the Project Directory**: Open your terminal and navigate to the directory where your project is located.\n2. **Build the Package**: Execute `poetry build` to create the wheel file. This will generate a `dist` folder in your project directory containing the `.whl` file, whose name may vary based on the version and build.\n\n### Installing the Wheel File\n1. **Navigate to the `dist` Directory**: Move to the `dist` directory where the `.whl` file is located.\n2. **Install the Wheel File**: Use `pip install [wheel-file-name]` to install the package. Replace `[wheel-file-name]` with the actual name of the wheel file generated during the build process.\n\n### Using the Installed Package\nAfter installation, the package can be used from anywhere on your system, provided you are running the Python interpreter where it was installed. For example:\n\n```bash\nmozilla-linux-pkg-manager clean-up --product firefox --channel nightly --retention-days 3\n```\n\n",
"bugtrack_url": null,
"license": "MPL-2.0",
"summary": "`mozilla-releng/mozilla-linux-pkg-manager` is a Python tool for managing Mozilla `.deb` packages.",
"version": "0.1.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2f7d8e3f2f88f88b485df77169c5bf2360e2aecda288c7194e0bfb1c8674ad83",
"md5": "71b99582eee3c99650d4fbd89f96055c",
"sha256": "e77c7dfe16cf2a1811cbf6b2be568c5ce98e271828ccb990fb541b79c18b8b07"
},
"downloads": -1,
"filename": "mozilla_linux_pkg_manager-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "71b99582eee3c99650d4fbd89f96055c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11,<4.0",
"size": 10255,
"upload_time": "2023-11-16T21:53:29",
"upload_time_iso_8601": "2023-11-16T21:53:29.839163Z",
"url": "https://files.pythonhosted.org/packages/2f/7d/8e3f2f88f88b485df77169c5bf2360e2aecda288c7194e0bfb1c8674ad83/mozilla_linux_pkg_manager-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a6a00fb7f71a39758a01439d5e1f87ec6f366f63b8bb2955f69b57d853f4562a",
"md5": "1abe7afba3441e1016e43bdc414ef38d",
"sha256": "1174be7906aa26a90ddb8f63e297104255c6c2c1ce5a7dab253704e041af2543"
},
"downloads": -1,
"filename": "mozilla_linux_pkg_manager-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "1abe7afba3441e1016e43bdc414ef38d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11,<4.0",
"size": 9372,
"upload_time": "2023-11-16T21:53:31",
"upload_time_iso_8601": "2023-11-16T21:53:31.466898Z",
"url": "https://files.pythonhosted.org/packages/a6/a0/0fb7f71a39758a01439d5e1f87ec6f366f63b8bb2955f69b57d853f4562a/mozilla_linux_pkg_manager-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-16 21:53:31",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "mozilla-linux-pkg-manager"
}
