.. role:: bash(code)
:language: bash
********
Deskmaid
********
|ci-docs| |ci-lint| |ci-tests| |pypi| |versions| |discord| |license|
.. |ci-docs| image:: https://github.com/Dashstrom/deskmaid/actions/workflows/docs.yml/badge.svg
:target: https://github.com/Dashstrom/deskmaid/actions/workflows/docs.yml
:alt: CI : Docs
.. |ci-lint| image:: https://github.com/Dashstrom/deskmaid/actions/workflows/lint.yml/badge.svg
:target: https://github.com/Dashstrom/deskmaid/actions/workflows/lint.yml
:alt: CI : Lint
.. |ci-tests| image:: https://github.com/Dashstrom/deskmaid/actions/workflows/tests.yml/badge.svg
:target: https://github.com/Dashstrom/deskmaid/actions/workflows/tests.yml
:alt: CI : Tests
.. |pypi| image:: https://img.shields.io/pypi/v/deskmaid.svg
:target: https://pypi.org/project/deskmaid
:alt: PyPI : deskmaid
.. |versions| image:: https://img.shields.io/pypi/pyversions/deskmaid.svg
:target: https://pypi.org/project/deskmaid
:alt: Python : versions
.. |discord| image:: https://img.shields.io/badge/Discord-dashstrom-5865F2?style=flat&logo=discord&logoColor=white
:target: https://dsc.gg/dashstrom
:alt: Discord
.. |license| image:: https://img.shields.io/badge/license-MIT-green.svg
:target: https://github.com/Dashstrom/deskmaid/blob/main/LICENSE
:alt: License : MIT
Description
###########
Deskmaid is a configurable desktop cleaner.
It scans your desktop and moves selected files to a folder, organizing them by file extension.
Everything can be configured in :bash:`~/.config/deskmaid/config.yml`.
Installation
############
You can install :bash:`deskmaid` using `pipx <https://pipx.pypa.io/stable/>`_
from `PyPI <https://pypi.org/project>`_
.. code-block:: bash
pip install pipx
pipx ensurepath
pipx install deskmaid
deskmaid shortcut
This will install two shortcuts on your desktop:
.. image:: https://raw.githubusercontent.com/Dashstrom/deskmaid/main/docs/resources/shortcuts.png
:alt: Two shortcuts, one with Thoru vacuuming and the other with Kanna opening her mouth wide, both people are from the anime Miss Kobayashi's Dragon Maid
How to cancel a run ?
#####################
Open shell then run:
.. code-block:: bash
deskmaid undo
Development
###########
Contributing
************
Contributions are very welcome. Tests can be run with :bash:`poe check`, please
ensure the coverage at least stays the same before you submit a pull request.
Setup
*****
You need to install `Poetry <https://python-poetry.org/docs/#installation>`_
and `Git <https://git-scm.com/book/en/v2/Getting-Started-Installing-Git>`_
for work with this project.
.. code-block:: bash
git clone https://github.com/Dashstrom/deskmaid
cd deskmaid
poetry install --all-extras
poetry run poe setup
poetry shell
Poe
********
Poe is available for help you to run tasks.
.. code-block:: text
test Run test suite.
lint Run linters: ruff checker and ruff formatter and mypy.
format Run linters in fix mode.
check Run all checks: lint, test and docs.
check-tag Check if the current tag match the version.
cov Run coverage for generate report and html.
locale Compile locale and refresh .po and .mo files.
open-cov Open html coverage report in webbrowser.
docs Build documentation.
open-docs Open documentation in webbrowser.
setup Setup pre-commit.
pre-commit Run pre-commit.
commit Test, commit and push.
clean Clean cache files.
Skip commit verification
************************
If the linting is not successful, you can't commit.
For forcing the commit you can use the next command :
.. code-block:: bash
git commit --no-verify -m 'MESSAGE'
Commit with commitizen
**********************
To respect commit conventions, this repository uses
`Commitizen <https://github.com/commitizen-tools/commitizen?tab=readme-ov-file>`_.
.. code-block:: bash
poe commit
How to add dependency
*********************
.. code-block:: bash
poetry add 'PACKAGE'
Ignore illegitimate warnings
****************************
To ignore illegitimate warnings you can add :
- **# noqa: ERROR_CODE** on the same line for ruff.
- **# type: ignore[ERROR_CODE]** on the same line for mypy.
- **# pragma: no cover** on the same line to ignore line for coverage.
- **# doctest: +SKIP** on the same line for doctest.
Uninstall
#########
.. code-block:: bash
pipx uninstall deskmaid
License
#######
This work is licensed under `MIT <https://github.com/Dashstrom/deskmaid/blob/main/LICENSE>`_.
Raw data
{
"_id": null,
"home_page": "https://github.com/Dashstrom/deskmaid",
"name": "deskmaid",
"maintainer": "Dashstrom",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "dashstrom.pro@gmail.com",
"keywords": "python, utility, script, desktop, cleaner",
"author": "Dashstrom",
"author_email": "dashstrom.pro@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/20/01/fbb9e53c23830d8e6dd93516534faa36f3327b6074c58eb441e653f01ac2/deskmaid-2.0.2.tar.gz",
"platform": null,
"description": ".. role:: bash(code)\n :language: bash\n\n********\nDeskmaid\n********\n\n|ci-docs| |ci-lint| |ci-tests| |pypi| |versions| |discord| |license|\n\n.. |ci-docs| image:: https://github.com/Dashstrom/deskmaid/actions/workflows/docs.yml/badge.svg\n :target: https://github.com/Dashstrom/deskmaid/actions/workflows/docs.yml\n :alt: CI : Docs\n\n.. |ci-lint| image:: https://github.com/Dashstrom/deskmaid/actions/workflows/lint.yml/badge.svg\n :target: https://github.com/Dashstrom/deskmaid/actions/workflows/lint.yml\n :alt: CI : Lint\n\n.. |ci-tests| image:: https://github.com/Dashstrom/deskmaid/actions/workflows/tests.yml/badge.svg\n :target: https://github.com/Dashstrom/deskmaid/actions/workflows/tests.yml\n :alt: CI : Tests\n\n.. |pypi| image:: https://img.shields.io/pypi/v/deskmaid.svg\n :target: https://pypi.org/project/deskmaid\n :alt: PyPI : deskmaid\n\n.. |versions| image:: https://img.shields.io/pypi/pyversions/deskmaid.svg\n :target: https://pypi.org/project/deskmaid\n :alt: Python : versions\n\n.. |discord| image:: https://img.shields.io/badge/Discord-dashstrom-5865F2?style=flat&logo=discord&logoColor=white\n :target: https://dsc.gg/dashstrom\n :alt: Discord\n\n.. |license| image:: https://img.shields.io/badge/license-MIT-green.svg\n :target: https://github.com/Dashstrom/deskmaid/blob/main/LICENSE\n :alt: License : MIT\n\nDescription\n###########\n\nDeskmaid is a configurable desktop cleaner.\nIt scans your desktop and moves selected files to a folder, organizing them by file extension.\nEverything can be configured in :bash:`~/.config/deskmaid/config.yml`.\n\nInstallation\n############\n\nYou can install :bash:`deskmaid` using `pipx <https://pipx.pypa.io/stable/>`_\nfrom `PyPI <https://pypi.org/project>`_\n\n.. code-block:: bash\n\n pip install pipx\n pipx ensurepath\n pipx install deskmaid\n deskmaid shortcut\n\nThis will install two shortcuts on your desktop:\n\n.. image:: https://raw.githubusercontent.com/Dashstrom/deskmaid/main/docs/resources/shortcuts.png\n :alt: Two shortcuts, one with Thoru vacuuming and the other with Kanna opening her mouth wide, both people are from the anime Miss Kobayashi's Dragon Maid\n\nHow to cancel a run ?\n#####################\n\nOpen shell then run:\n\n.. code-block:: bash\n\n deskmaid undo\n\nDevelopment\n###########\n\nContributing\n************\n\nContributions are very welcome. Tests can be run with :bash:`poe check`, please\nensure the coverage at least stays the same before you submit a pull request.\n\nSetup\n*****\n\nYou need to install `Poetry <https://python-poetry.org/docs/#installation>`_\nand `Git <https://git-scm.com/book/en/v2/Getting-Started-Installing-Git>`_\nfor work with this project.\n\n.. code-block:: bash\n\n git clone https://github.com/Dashstrom/deskmaid\n cd deskmaid\n poetry install --all-extras\n poetry run poe setup\n poetry shell\n\nPoe\n********\n\nPoe is available for help you to run tasks.\n\n.. code-block:: text\n\n test Run test suite.\n lint Run linters: ruff checker and ruff formatter and mypy.\n format Run linters in fix mode.\n check Run all checks: lint, test and docs.\n check-tag Check if the current tag match the version.\n cov Run coverage for generate report and html.\n locale Compile locale and refresh .po and .mo files.\n open-cov Open html coverage report in webbrowser.\n docs Build documentation.\n open-docs Open documentation in webbrowser.\n setup Setup pre-commit.\n pre-commit Run pre-commit.\n commit Test, commit and push.\n clean Clean cache files.\n\nSkip commit verification\n************************\n\nIf the linting is not successful, you can't commit.\nFor forcing the commit you can use the next command :\n\n.. code-block:: bash\n\n git commit --no-verify -m 'MESSAGE'\n\nCommit with commitizen\n**********************\n\nTo respect commit conventions, this repository uses\n`Commitizen <https://github.com/commitizen-tools/commitizen?tab=readme-ov-file>`_.\n\n.. code-block:: bash\n\n poe commit\n\nHow to add dependency\n*********************\n\n.. code-block:: bash\n\n poetry add 'PACKAGE'\n\nIgnore illegitimate warnings\n****************************\n\nTo ignore illegitimate warnings you can add :\n\n- **# noqa: ERROR_CODE** on the same line for ruff.\n- **# type: ignore[ERROR_CODE]** on the same line for mypy.\n- **# pragma: no cover** on the same line to ignore line for coverage.\n- **# doctest: +SKIP** on the same line for doctest.\n\nUninstall\n#########\n\n.. code-block:: bash\n\n pipx uninstall deskmaid\n\nLicense\n#######\n\nThis work is licensed under `MIT <https://github.com/Dashstrom/deskmaid/blob/main/LICENSE>`_.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Configurable desktop cleaner.",
"version": "2.0.2",
"project_urls": {
"Documentation": "https://dashstrom.github.io/deskmaid",
"Homepage": "https://github.com/Dashstrom/deskmaid",
"Repository": "https://github.com/Dashstrom/deskmaid"
},
"split_keywords": [
"python",
" utility",
" script",
" desktop",
" cleaner"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bc2af796a1c554fe8e59320478cfbd6c85f4f2cbf7d4c5de87f750458ad84611",
"md5": "3f83bd4e7e6040ed77c1ad22a89088bb",
"sha256": "add4b8a5d14429c6cc40cb4e942762383945b5c5966422d0953544494842ec71"
},
"downloads": -1,
"filename": "deskmaid-2.0.2-cp38-cp38-manylinux_2_31_x86_64.whl",
"has_sig": false,
"md5_digest": "3f83bd4e7e6040ed77c1ad22a89088bb",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": ">=3.8",
"size": 270805,
"upload_time": "2024-09-14T07:40:34",
"upload_time_iso_8601": "2024-09-14T07:40:34.792487Z",
"url": "https://files.pythonhosted.org/packages/bc/2a/f796a1c554fe8e59320478cfbd6c85f4f2cbf7d4c5de87f750458ad84611/deskmaid-2.0.2-cp38-cp38-manylinux_2_31_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2001fbb9e53c23830d8e6dd93516534faa36f3327b6074c58eb441e653f01ac2",
"md5": "2d46c07d62f4a68a282c62f95f9ce9ad",
"sha256": "16998d3ff479ab3d95f9f3adc8de0218928b3740cfcb821a19339bbea5f1b61a"
},
"downloads": -1,
"filename": "deskmaid-2.0.2.tar.gz",
"has_sig": false,
"md5_digest": "2d46c07d62f4a68a282c62f95f9ce9ad",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 263887,
"upload_time": "2024-09-14T07:40:36",
"upload_time_iso_8601": "2024-09-14T07:40:36.660744Z",
"url": "https://files.pythonhosted.org/packages/20/01/fbb9e53c23830d8e6dd93516534faa36f3327b6074c58eb441e653f01ac2/deskmaid-2.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-14 07:40:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Dashstrom",
"github_project": "deskmaid",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "deskmaid"
}
JSON
